Subscribe a contact

The method is used for the integration of subscription forms.
If a contact does not exist, it is created with the non-confirmed email.
If a contact exists, the contact fields are updated (except existing media channels).
New contacts are created with a not confirmed status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The method for double opt-in implementation. A created contact is unconfirmed.
It is impossible to send bulk emails to such contacts until they confirm their subscription; however, they are available for receiving important trigger messages.
An event will be automatically generated after this method is called.
Sending a confirmation email can be implemented using the mechanism of events and campaigns.
When clicking the link in the letter, a contact becomes confirmed and available for bulk emails sending.

contact
object
required

Contact for subscription.

groups
array of strings

The list of segment names where a new/updated contact will be added.

groups
subscriptions
array of strings

Subscription categories added for a contact.

subscriptions
string

The subscription form name. It allows you to use several independent subscription forms.
All characters are acceptable, except: < ; ’ \ / | " ` ' ^ ? ! , >

Responses

400

Bad request

401

Unauthorized

405

Method not allowed

409

Conflict:

  • Repeated request within 1 minute.

415

Unsupported media type

429

Too many requests:

  • More than 200 requests per 1 second.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=UTF-8