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
get
Get account information
View All 1
Address books
post
Create address book
delete
Delete address book
put
Update address book
get
Get address book
get
Get address books
get
Get private address books
get
Get public address books
View All 7
Campaigns
post
Create campaign
put
Update campaign
post
Copy campaign
delete
Delete campaign
post
Send campaign
post
Send time optimised campaign
get
Get campaign send status
post
Add campaign attachment
delete
Remove campaign attachment
get
Get campaign attachments
get
Get all campaigns
get
Get campaigns sent to address book or segment
get
Get campaign
get
Get campaign summary
get
Get campaign opens
get
Get campaign opens for a contact
get
Get campaign activity for a contact
get
Get campaign activity since date
get
Get campaign clicks
get
Get campaign clicks since date
get
Get campaign opens since date
get
Get campaign activity
get
Get campaign address books
get
Get campaign clicks for a contact
get
Get campaigns with activity since date
get
Get campaign page views for a contact
get
Get campaign page views since date
get
Get campaign replies for a contact
get
Get campaign ROI activity for a contact
get
Get campaign ROI activity since date
get
Get campaign social bookmark views
get
Get campaign social bookmark views for a contact
get
Get campaign hard bouncers
View All 33
Contacts
post
Create contact
delete
Delete contact
put
Update contact
post
Add contact to address book
delete
Delete contact from address book
post
Delete contacts from address book
delete
Delete all contacts from address book
get
Get contact by email
get
Get contact by ID
get
Get contact address books
get
Get contacts
get
Get contacts created since date
post
Bulk create contacts
post
Bulk create contacts in address book
get
Get contact import status
get
Get contact import report
get
Get contact import report faults
get
Get contacts from address book
get
Get modified contacts in address book since date
get
Get modified contacts since date
get
Get suppressed contacts since date
get
Get unsubscribed contacts since date
get
Get unsubscribed contacts from address book since date
post
Unsubscribe contact
post
Unsubscribe contact from address book
post
Resubscribe contact
post
Resubscribe contact to address book
get
Get scoring for contacts
get
Get scoring for contacts in address book
get
Get scoring modified since date for contacts
get
Get scoring for contact by email
get
Get scoring for contact by ID
View All 32
Contact data fields
post
Create contact data field
delete
Delete contact data field
get
Get contact data fields
View All 3
Custom from addresses
get
Get custom from addresses
View All 1
Document folders
post
Create document folder
get
Get document folders
get
Get documents in folder
post
Upload document
View All 4
Image folders
post
Create image folder
get
Get image folders
get
Get image folder by ID
post
Upload campaign image
View All 4
Programs
get
Get programs
get
Get program by ID
post
Create program enrolment
get
Get program enrolment report faults
get
Get program enrolment
get
Get program enrolments by status
View All 6
Segments
get
Get segments
post
Refresh segment
get
Get refresh progress for segment
View All 3
Server time
get
Get server time
View All 1
SMS
post
Send SMS message
View All 1
Surveys and forms
get
Get surveys
get
Get survey by ID
get
Get survey fields
get
Get survey responses
get
Get survey responses with activity since date
get
Get surveys with activity since date
View All 6
Templates
post
Create template
get
Get template by ID
get
Get templates
put
Update template
View All 4
Transactional data
post
Add transactional data to contact
post
Bulk add transactional data to contacts
get
Get transactional data import status
get
Get transactional data import report
delete
Delete transactional data collection for contact by email
get
Get transactional data collection for contact by email
delete
Delete transactional data collection for contact by ID
post
Replace transactional data by key
delete
Delete transactional data by key
get
Get transactional data by key
View All 10
Transactional email
post
Send transactional email
post
Send transactional email using a triggered campaign
get
Get 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