Integrating Subscription Form via API
To integrate a subscription form, use the API resource Subscribe contact.
Request Body
The standard request body looks as follows:
{
"contact" : {
"channels" : [ {
"type" : "email",
"value" : "test@mail.com"
} ]
}
}
After a resource call, one contact with the email address test@mail.com will be added to the system.
To configure the contact name, add the firstName value to the contact field:
{
"contact" : {
"firstName" : "...",
"channels" : [ {
"type" : "email",
"value" : "test@mail.com"
} ]
}
}
To specify the segments where the subscribed contact will be added, add to the request the groups field - the string array, segment names. If the specified segments don’t exist in the system, they will be created automatically:
{
"contact" : {
"firstName" : "...",
"channels" : [ {
"type" : "email",
"value" : "test@mail.com"
} ]
},
"groups" : [ "Subscribers" ]
}
Generating Events
Once this resource is called, the system automatically generates one of two events:
- subscribeFromAPI if a new contact has been created;
- subscribeUpdateFromAPI - if such a contact exists.
You can see these events in Automation > Event history.
![93d4150-API_17.png Event history](https://files.readme.io/ad07aca-93d4150-API_17.png)
Adding Workflow
Any event can be added to a workflow. When an event that is incorporated in a workflow is triggered, the workflow launch begins. For new contacts, it is advisable to send a subscription confirmation.
To make sure a new contact is created, go to Contacts - All Contacts, and enter the necessary email address into the search.
![1f81dea-API_18.png Adding Workflow](https://files.readme.io/cc93fe0-1f81dea-API_18.png)
The found contact will be highlighted in gray. This means the contact’s email address is inactive and requires confirmation.
![a66f5eb-API_19.png Contact’s email address](https://files.readme.io/945f8c0-a66f5eb-API_19.png)
You can't send any campaigns to such addresses besides a subscription confirmation email and other transactional emails, for example, an abandoned cart or order confirmation.
Updated over 1 year ago