Ready to jump in and start automating? 

Find specifications, descriptions, references, guides, and other information on the Emarsys Developer Hub.

For data collection commands, see: Web Extend data collection.

Emarsys Core API

Contact management

Contacts
Create contacts	POST/v2/contact
Get contact data	POST/v2/contact/getdata
List contact data	GET/v2/contact/query
Update contacts	PUT/v2/contact
Delete a contact Delete multiple contacts	POST/v2/contact/delete
Get internal contact identifier	GET/v2/contact/query/{keyId}={keyValue}
Verify internal contact identifiers	POST/v2/contact/checkids
Get contact email history	POST/v2/contact/getcontacthistory
Fields
Create a field	POST/v2/field
List available fields	GET/v2/field/translate/{languageId}
List available choices of a single field	GET/v2/field/{fieldID}/choice/translate/{languageId}
List available choices of a multiple-choice field	GET/v2/field/choices
Delete a field	DELETE/v2/field/{fieldId}
Query field changes	POST/v2/contact/last_change
Contact lists
Create a contact list	POST/v2/contactlist
List contact Lists	GET/v2/contactlist
Rename a contact list	POST/v2/contactlist/{listId}/rename
Replace a contact list	POST/v2/contactlist/{listId}/replace
Delete a contact list	POST/v2/contactlist/{listId}/deletelist
Add contacts to a contact list	POST/v2/contactlist/{listId}/add
Count contacts in a contact list	GET/v2/contactlist/{listId}/count
List contacts in a contact list	GET/v2/contactlist/{listId}
Get contact data in a contact list	GET/v2/contactlist/{listId}/contacts/data
Look up a contact in a contact list	GET/v2/contactlist/{listId}/contacts/
Remove contacts from a contact list	POST/v2/contactlist/{listId}/delete
Segments
Create a segment	PUT/v2/filter
List segments	GET/v2/filter/{segmentId}
Update contact criteria in a segment	GET/v2/filter/{segmentId}/contact_criteria
Delete a segment	GET/v2/filter/{segmentId}/delete
Count contacts in a segment	GET/v2/filter/{segmentId}/contacts/count
Get segment contact criteria	GET/v2/filter/{segmentId}/contact_criteria
Look up a contact in a segment	GET/v2/filter/{segmentId}/contacts/{contactId}
Run a segment for a single contact	POST/v2/filter/{segmentId}/single_runs
Poll the status of a segment run for a single contact	GET/v2/filter/single_runs/{runId}
Run a segment for multiple contacts	POST/v2/filter/{segmentId}/runs
Poll the status of a segment run for multiple contacts	GET/v2/filter/runs/{runId}
Contact sources
List contact sources	GET/v2/source
Delete a contact source	GET/v2/source/{sourceId}
Forms
List customer forms	GET/v2/form
Trigger contact registration	POST/v2/form/{formId}/trigger

Email campaign management

Email campaigns
Create an email campaign	POST/v2/email
List email campaigns	GET/v2/email
Get email campaign data	GET/v2/email/{emailId}
Get email campaign languages	GET/v2/language
Get email campaign categories	GET/v2/emailcategory
Update an email campaign recipient source	POST/v2/email/{emailId}/updatesource
Update an email campaign	POST/v2/email/{emailId}/patch
Delete an email campaign	POST/v2/email/delete
Version an email campaign	POST/v2/email/{emailId}/version
Finalize a multi-language email campaign	POST/v2/email/{emailId}/finalize
Copy an email campaign	POST/v2/email/{emailId}/copy
Blocklist emails and domains	POST/v2/blocklist
List AC Programs That Use an Email Campaign	GET/v2/email/{campaign_id}/programs
Campaign launch (Email Campaign Lifecycle)
Preview email campaign contents	POST/v2/email/{emailId}/preview
Send a test email	POST/v2/email/{emailId}/sendtestmail
Launch an email campaign	POST/v2/email/{emailId}/launch
Launch an email campaign to virtual contacts (broadcast)	POST/v2/email/{emailId}/broadcast
Stop an Email Campaign	POST/v2/email/{emailId}/stop
Query delivery status	POST/v2/email/getdeliverystatus
Query email response metrics and deliverability	POST/v2/email/responses
Get email response metrics and deliverability results	GET/v2/email/{queryId}/responses
Get a response summary	GET/v2/email/{emailId}/responsesummary
List email campaign launches	POST/v2/email/getlaunchesofemail
List personalization alternate texts	GET/v2/email/{emailId}/personalization
Get the URL of a launched email campaign content	POST/v2/email/{emailId}/url
Unsubscribe a contact from an email campaign	POST/v2/email/unsubscribe
Media database
Create a Media Database folder	POST/v2/folder
Get a Media Database file	GET/v2/file/{fileId}
List Media Database folders	GET/v2/folder
List Media Database files	GET/v2/file
Upload a file into the Media Database	POST/v2/file
Delete a Media Database file	POST/v2/file/{fileId}/delete
Conditional text rules
List conditional text rules	GET/v2/condition
Email templates
List email templates	GET/v2/email/templates
Get an email template	GET/v2/email/templates/{templateId}
Tracked links
Create a tracked link in an email campaign	POST/v2/email/{emailId}/trackedlinks
List tracked links in an email campaign	GET/v2/email/{emailId}/trackedlinks/{linkId}
List link categories	GET/v2/settings/linkcategories
Update a tracked link in an email campaign	POST/v2/email/{emailId}/trackedlinks/{linkId}
Delete a tracked link in an email campaign	POST/v2/email/{emailId}/deletetrackedlinks/{linkId}
Sections
Create a section in a template-based email campaign	POST/v2/email/{emailId}/sections
List sections in a template-based email campaign	GET/v2/email/{emailId}/sections
Get a section of a template-based email campaign	GET/v2/email/{emailId}/sections/{sectionId}
Update a section of a template-based email campaign	POST/v2/email/{emailId}/sections/{sectionId}
Delete a section from a template-based email campaign	POST/v2/email/{emailId}/sections/{sectionId}/delete

External events

Events
Create an external event	POST/v2/event
List external events	GET/v2/event/
Query an external event	GET/v2/event/{eventId}
List uses of an external event	GET/event/{eventId}/usages
Update an external event	POST/v2/event/{eventId}
Delete an external event	POST/v2/event/{eventId}/delete
Trigger an external event	POST/v2/event/{eventId}/trigger

Wishlist events

Events
Trigger a Wishlist Update	POST/api/v2/wishlist/update

Add-ons

External content
Request external content for personalization	POST/https://{customer-website.com}/api/example/

Automation Center programs

Programs
List programs	GET/v2/ac/programs
List program resources in use	GET/v2/programresource
Start a program	POST/v2/ac/programs/entrypoints/{nodeType}/resources/{resourceId}/runs
Abort a program Important: Please note that this endpoint was deprecated in July 2022.	POST/v2/ac/programs/{program_id}/abort
Delete a program	POST/v2/ac/programs/{program_id}/delete

Data management

Contact and email data
Export updated contacts	POST/v2/contact/getchanges
Export a contact list	POST/v2/email/getcontacts
Export a segment	POST/v2/export/filter
Export contact registrations	POST/v2/contact/getregistrations
Export responses	POST/v2/email/getresponses
Check export status	GET/v2/export/{exportId}
Download export data	GET/v2/export/{exportId}/data
Auto-import profiles
Create an auto-import profile	POST/v2/settings/autoimports
List auto-import profiles	GET/v2/settings/autoimports
Query an auto-import profile	GET/v2/settings/autoimports/{profileId}
Delete an auto-import profile	POST/v2/settings/autoimports/{profileId}/delete

Relational data
Insert records into an RDS table	POST/rds/connections/{connectionName}/tables/{tableName}/records
Query records in an RDS table	GET/rds/connections/{connectionName}/tables/{tableName}/records
Update records in an RDS table	PATCH/rds/connections/{connectionName}/tables/{tableName}/records
Upsert records in an RDS table	POST/rds/connections/{connectionName}/tables/{tableName}/records/upsert
Replace an RDS table	PUT/rds/connections/{connectionName}/tables/{tableName}/records
Delete records from an RDS table	POST/rds/connections/{connectionName}/tables/{tableName}/records/remove

Account administration

Accounts
Create an administrator account	POST/v2/administrator
Get customer settings	GET/v2/settings
Get administrator details	GET/v2/administrator/query/{administratorId}
List administrator accounts	GET/v2/administrator
Update an administrator account	POST/v2/administrator/{administratorId}/patch
List access levels	GET/v2/administrator/getaccesslevels
Create a session for an administrator account	POST/v2/administrator/{administratorId}/session
Get user interface languages	GET/v2/administrator/getinterfacelanguages
Get account languages	GET/v2/settings/languages/translation/en
List administrator start pages	GET/v2/administrator/getstartpages
Send a notification message	POST/v2/notification
Keys
Create a key in the keyring	POST/v2/settings/keyrings
Retrieve a key from the keyring	POST/v2/settings/keyring/keys/{keyId}
List keys in the keyring	POST/v2/keyring/keys
Delete a key from the keyring	POST/v2/keyring/keys/{keyId}/delete

Emarsys SMS API

SMS API endpoints
List SMS campaigns	GET/sms/campaigns
Get SMS campaign	GET/sms/campaigns/{campaignId}
Create SMS campaign	POST/sms/campaigns
Update SMS campaigns	PUT/sms/campaigns/{campaignId}
Launch SMS campaign	PATCH/sms/campaigns/{campaignId}
Query inbound SMS messages	GET/sms/inbound-messages

Emarsys Partner SMS

Emarsys SMS Partner Service Endpoints	https://api.sms-partner.io/sms/partner
Create or update client configuration	PUT/v1/clients/{clientId}/configuration
Get client configuration	GET/v1/clients/{clientId}/configuration
Delete client configuration	DELETE/v1/clients/{clientId}/configuration
Test connection	POST/v1/testConnection
Send messages	POST/v1/clients/{clientId}/messages

Emarsys SMS Partner Callbacks Endpoints	https://api.sms-partner.io/sms/partner
Delivery reports callback	POST/clients/{clientId}/deliveryReports
Inbound messages callback	POST/clients/{clientId}/inboundMessages

Emarsys Loyalty API (v4)

Emarsys Loyalty API endpoints
Get actions available for the contact that can earn them rewards	GET/contact/actions
Get a contact's loyalty activity information	GET/contact/activities
Mark exclusive voucher as accessed	PUT/contact/exclusive/accessed
Remove a used exclusive access voucher	DELETE/contact/exclusive
Redeem an exclusive access voucher for a contact	POST/contact/exclusives/redeem
Get the Emarsys hashed version of the external contact Id	GET/contact/hash
Join contact to loyalty program (create contact if required)	POST/contact/join
Remove points from a contact	PUT/contact/points/remove
Allocate points to a contact	PUT/contact/points/add
Delete a contact from the loyalty program	DELETE/contact
Get a contact's loyalty information	GET/contact
Change a contact’s plan	PUT/contact/changeplan
Get a referral code	POST/contact/getReferralCode
Show the referred friend’s content	GET/contact/referralFriendContent
Get a contact’s referral information	GET/contact/referrals
Get program settings	GET/contact/programSettings
Get a contact’s additional benefits	GET/contact/additionalBenefits
Add additional benefits to a contact	PUT/contact/additionalBenefits/add
Remove additional benefits of a contact	PUT/contact/additionalBenefits/remove
Create group	POST/group
Add contacts to a group	PUT/group/addContacts
Remove contacts from a group	PUT/group/removeContacts
Redeem a voucher for a contact	POST/contact/voucher/redeem
Remove an already used voucher from a contact	DELETE/contact/voucher
Get all vouchers for a contact	GET/contact/vouchers
Remove exclusive access voucher	DELETE/contact/exclusive
Redeem an exclusive voucher	POST/contact/exclusive/redeem
Mark an exclusive access voucher	PUT/contact/exclusive/accessed
Get the tiers of a contact	GET/contact/tiers
Upgrade tier of a contact	PUT/contact/tiers/upgrade
Downgrade tier of a contact	PUT/contact/tiers/downgrade