dotmailer

{"id":"55dd9f2e0efd5821000d54d9","name":"dotmailer","subdomain":"dotmailer","versions":[{"_id":"55dd9f4dab0e4d210045aae9","releaseDate":"2015-08-26T11:13:17.024Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"}],"doc_slug":"","current_version":{"version_clean":"2.0.0","version":"2"},"oauth":{"enabled":false},"api":{"name":"","url":"https://[region ID]-api.dotmailer.com","contenttype":"json","auth":"basic","explorer":false,"proxyEnabled":true,"jwt":false,"authextra":[{"_id":"55e82e14054c0a23001b1e46","type":"","default":"","key":""}],"headers":[],"object_definitions":[]},"apiAlt":[],"plan_details":{"name":"Developer Hub","is_active":true,"cost":59,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":false,"errors":false,"password":true,"landing_page":true,"themebuilder":true,"stylesheet":true,"javascript":false,"html":true,"extra_html":false,"admins":true,"apps":true},"apps":{"enabled":false},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"autoSslGeneration":false,"ssl":true},"asset_base_url":""}
    • v2
    • {{ u.user.name }}
      • Admin Panel
      • Log Out
    • Log In

    The dotmailer developer hub

    This is the official dotmailer API documentation, for both REST and SOAP.

    Get Started

    Overview

    • Getting started with the API
    • FAQs
    • Error response types
    • Using OAuth 2.0 with dotmailer
    • Adding products to your AccountInsight for use in EasyEditor product blocks
    • Sending a transactional email as a triggered campaign
    • View All 6

    REST

    • About our REST API
    • REST API quick reference
    • View All 2

    Account information

    • getGet account information
    • View All 1

    Address books

    • postCreate address book
    • deleteDelete address book
    • putUpdate address book
    • getGet address book
    • getGet address books
    • getGet private address books
    • getGet public address books
    • View All 7

    Campaigns

    • postCreate campaign
    • putUpdate campaign
    • postCopy campaign
    • deleteDelete campaign
    • postSend campaign
    • postSend time optimised campaign
    • getGet campaign send status
    • postAdd campaign attachment
    • deleteRemove campaign attachment
    • getGet campaign attachments
    • getGet all campaigns
    • getGet campaigns sent to address book or segment
    • getGet campaign
    • getGet campaign summary
    • getGet campaign opens
    • getGet campaign opens for a contact
    • getGet campaign activity for a contact
    • getGet campaign activity since date
    • getGet campaign clicks
    • getGet campaign clicks since date
    • getGet campaign opens since date
    • getGet campaign activity
    • getGet campaign address books
    • getGet campaign clicks for a contact
    • getGet campaigns with activity since date
    • getGet campaign page views for a contact
    • getGet campaign page views since date
    • getGet campaign replies for a contact
    • getGet campaign ROI activity for a contact
    • getGet campaign ROI activity since date
    • getGet campaign social bookmark views
    • getGet campaign social bookmark views for a contact
    • getGet campaign hard bouncers
    • View All 33

    Contacts

    • postCreate contact
    • deleteDelete contact
    • putUpdate contact
    • postAdd contact to address book
    • deleteDelete contact from address book
    • postDelete contacts from address book
    • deleteDelete all contacts from address book
    • getGet contact by email
    • getGet contact by ID
    • getGet contact address books
    • getGet contacts
    • getGet contacts created since date
    • postBulk create contacts
    • postBulk create contacts in address book
    • getGet contact import status
    • getGet contact import report
    • getGet contact import report faults
    • getGet contacts from address book
    • getGet modified contacts in address book since date
    • getGet modified contacts since date
    • getGet suppressed contacts since date
    • getGet unsubscribed contacts since date
    • getGet unsubscribed contacts from address book since date
    • postUnsubscribe contact
    • postUnsubscribe contact from address book
    • postResubscribe contact
    • postResubscribe contact to address book
    • getGet scoring for contacts
    • getGet scoring for contacts in address book
    • getGet scoring modified since date for contacts
    • getGet scoring for contact by email
    • getGet scoring for contact by ID
    • View All 32

    Contact data fields

    • postCreate contact data field
    • deleteDelete contact data field
    • getGet contact data fields
    • View All 3

    Custom from addresses

    • getGet custom from addresses
    • View All 1

    Document folders

    • postCreate document folder
    • getGet document folders
    • getGet documents in folder
    • postUpload document
    • View All 4

    Image folders

    • postCreate image folder
    • getGet image folders
    • getGet image folder by ID
    • postUpload campaign image
    • View All 4

    Programs

    • getGet programs
    • getGet program by ID
    • postCreate program enrolment
    • getGet program enrolment report faults
    • getGet program enrolment
    • getGet program enrolments by status
    • View All 6

    Segments

    • getGet segments
    • postRefresh segment
    • getGet refresh progress for segment
    • View All 3

    Server time

    • getGet server time
    • View All 1

    SMS

    • postSend SMS message
    • View All 1

    Surveys and forms

    • getGet surveys
    • getGet survey by ID
    • getGet survey fields
    • getGet survey responses
    • getGet survey responses with activity since date
    • getGet surveys with activity since date
    • View All 6

    Templates

    • postCreate template
    • getGet template by ID
    • getGet templates
    • putUpdate template
    • View All 4

    Transactional data

    • postAdd transactional data to contact
    • postBulk add transactional data to contacts
    • getGet transactional data import status
    • getGet transactional data import report
    • deleteDelete transactional data collection for contact by email
    • getGet transactional data collection for contact by email
    • deleteDelete transactional data collection for contact by ID
    • postReplace transactional data by key
    • deleteDelete transactional data by key
    • getGet transactional data by key
    • View All 10

    Transactional email

    • postSend transactional email
    • postSend transactional email using a triggered campaign
    • getGet transactional email statistics
    • View All 3

    SOAP

    • About our SOAP API
    • SOAP API quick reference
    • View All 2

    Account information

    • GetCurrentAccountInfo
    • View All 1

    Address books

    • CreateAddressBook
    • UpdateAddressBook
    • DeleteAddressBook
    • GetAddressBooks
    • GetAddressBookById
    • GetAddressBooksForContact
    • GetAddressBooksForCampaign
    • View All 7

    Campaigns

    • CreateCampaign
    • UpdateCampaign
    • CopyCampaign
    • DeleteCampaign
    • SendCampaign
    • SendTimeOptimisedCampaign
    • GetCampaignSendProgress
    • AttachDocumentToCampaign
    • DetachDocumentFromCampaign
    • GetCampaignAttachments
    • GetCampaigns
    • GetCampaignsForAddressBook
    • GetCampaignById
    • GetCampaignSummary
    • GetCampaignOpens
    • GetCampaignOpensSinceDate
    • GetCampaignActivities
    • GetCampaignActivitiesSinceDate
    • GetSentCampaignsWithActivitySinceDate
    • GetCampaignClicks
    • GetCampaignClicksSinceDate
    • GetCampaignPageViewsSinceDate
    • GetCampaignContactActivity
    • GetCampaignContactClicks
    • GetCampaignContactOpens
    • GetCampaignContactPageViews
    • GetCampaignContactReplies
    • GetCampaignContactRoiDetails
    • GetCampaignRoiDetailsSinceDate
    • GetCampaignContactSocialBookmarkViews
    • GetCampaignSocialBookmarkViews
    • GetCampaignHardBouncingContacts
    • View All 32

    Contacts

    • CreateContact
    • DeleteContact
    • UpdateContact
    • AddContactToAddressBook
    • DeleteContactFromAddressBook
    • DeleteContactsFromAddressBook
    • DeleteAllContactsFromAddressBook
    • GetContactByEmail
    • GetContactById
    • GetContacts
    • GetModifiedContacts
    • GetNewContacts
    • ImportContacts
    • ImportContactsToAddressBook
    • GetContactImportProgress
    • GetContactImportReport
    • GetContactImportReportFaults
    • GetContactsInAddressBook
    • GetModifiedContactsInAddressBook
    • GetSuppressedContacts
    • GetUnsubscribedContacts
    • GetUnsubscribedContactsInAddressBook
    • UnsubscribeContact
    • UnsubscribeContactFromAddressBook
    • ResubscribeContact
    • ResubscribeContactToAddressBook
    • GetContactsScore
    • GetContactsScoreInAddressBook
    • GetContactsScoreModifiedSinceDate
    • GetContactScoreByEmail
    • GetContactScoreByContactId
    • View All 31

    Contact data fields

    • CreateDataField
    • DeleteDataField
    • GetDataFields
    • View All 3

    Custom from addresses

    • GetCustomFromAddresses
    • View All 1

    Document folders

    • CreateDocumentFolder
    • GetDocumentFolders
    • GetDocuments
    • UploadDocument
    • View All 4

    Image folders

    • CreateImageFolder
    • GetImageFolders
    • GetImageFolderById
    • UploadImage
    • View All 4

    Programs

    • GetPrograms
    • GetProgramById
    • CreateEnrolment
    • GetEnrolmentReport
    • GetEnrolmentById
    • GetEnrolmentsByStatus
    • View All 6

    Segments

    • GetSegments
    • RefreshSegment
    • GetSegmentRefreshProgress
    • View All 3

    Server time

    • GetServerTime
    • View All 1

    SMS

    • SendSingleSmsMessage
    • View All 1

    Surveys and forms

    • GetSurveys
    • GetSurveyById
    • GetSurveyFields
    • GetSurveyResponses
    • GetSurveyResponsesWithActivitySinceDate
    • GetSurveysWithActivitySinceDate
    • View All 6

    Templates

    • CreateTemplate
    • GetTemplateById
    • GetTemplates
    • UpdateTemplate
    • View All 4

    Transactional data

    • AddTransactionalData
    • ImportTransactionalData
    • GetTransactionalDataImportProgress
    • GetTransactionalDataImportReport
    • DeleteTransactionalDataByContact
    • GetTransactionalDataByContact
    • DeleteTransactionalDataByKey
    • ReplaceTransactionalDataByKey
    • GetTransactionalDataByKey
    • View All 9

    Transactional email

    • SendTransactionalEmail
    • SendTransactionalEmailTriggeredCampaign
    • GetTransactionalEmailStatistics
    • View All 3

    More help

    • Current status
    • Knowledge base
    • View All 2
    readme.io