Endpoints are used to create, read, update and delete resources. In a RESTful API, these actions are represented by verbs (also known as methods). These methods are communicated via the HTTP protocol as follows:
- GET - read data from the endpoint.
- HEAD - same as GET, except no data is returned.
- POST - create a new resource with the data you provide.
- PUT - update an existing resource with the data you provide.
- DELETE - delete an existing resource.
The order in which requests are issued, especially across the different verbs, will have a big impact on the speed, efficiency and accuracy of your integration. For example, resource a might be associated with resource b from another endpoint. Should you issue a DELETE on resource b first, or will this association be unlinked when you DELETE resource a?
The endpoint documentation listed below will help you assess these behaviours and help you integrate with best practice in mind. Our library of endpoints is constantly growing, so be sure to check back often or keep an eye on our Twitter!
Subscribers with an email address, domain name or MSISDN matching an entry on your 'Do Not Contact List' cannot be contacted.
Opt-in emails ensure that subscriptions are confirmed and genuine.
Folders are used for organising lists of subscribers.
Forms allow subscribers to sign up to hear from you. When a form is completed by a subscriber, the subscription (once confirmed) is added to one or more lists and data added to subscriberProfileData.
Bulk import subscribers into a list, creating a subscription for each record.
Exports subscriber data in CSV format.
Lists are held within folders and they contain subscribers. The relationship between a list and a subscriber is called a subscription.
Fetch one or more random subscribers from your account.
Powerful rules which can be used to segment your subscriber data.
Add and manage the core data set for a subscriber.
Subscriber profiles allow you to have custom data associated with a subscriber. Use subscriberProfileField to manage the data fields themselves and SubscriberProfileData to manage the data held by them.
Subscriber profiles allow you to have custom data associated with a subscriber. Use subscriberProfileField to manage the data fields themselves and subscriberProfileData to manage the data held by them.
Subscriptions link a subscriber to a list. A subscription must be confirmed opt-in before the subscriber can be contacted.
Retrieve or set your Email Templates.
Message provides details on email and SMS campaigns which can be sent to lists by a task.
Describes the content and supporting attributes of an email message.
Provides the links contained within an emailMessage.
Describes the content and supporting attributes of an SMS message.
Quickly send an SMS message to a single recipient without an smsMessage or task.
Retrieve information on your Marketing Automation rules.
Powerful automation rules which are triggered when a subscriber clicks a link in a message.
Powerful automation rules which are triggered before or after a given date.
Powerful automation rules which are triggered when a subscriber opens a message.
Powerful automation rules that enable a custom opt-in email to be triggered when a call to EmailOptin is made..
Trigger powerful automation rules when an SMS message is sent to an smsDestination related to your account.
Powerful automation rules which are triggered when a subscription occurs.
Sends a transactional email to a specified subscriber.
Retrieve or set the keyword for any destination active in your account.
Send a message preview to a single recipient without delay.
Face off up to five different versions of a message using splitTest to get the best results possible.
Sends a message to a series of subscriptions at the time provided. Automatically generates a record of contact for each recipient.
Bounces occur when a subscriber is contacted but the message can't be delivered to them.
A contact record is automatically generated when a task sends a message to a subscriber. Failed attempts to contact a subscriber are known as bounces.
Describes when a subscriber clicked a link in an email.
Describes when a subscriber opened an email.
Account provides administrative information about your Sign-Up.to account.
Provides an overview of feataures available to an account.
Generates a token for the specified service which can be used to log in to that service.
User provides details about the users on your Sign-Up.to account. You will always have one admin user and potentially additional sub-users.