The Aloware Sequence API enables contact enrollment and disenrollment in sequences through API integration, automating contact management and streamlining communication workflows.
This document provides details on the required fields, examples, and endpoints for enrolling and disenrolling contacts in sequences using the Aloware Sequence API which you can find in the Integrations menu > Sequences API.
Enroll a Contact to a Sequence
Endpoint
POST /api/v1/webhook/sequence-enroll
Required Fields
api_token | Your Aloware account API token. |
sequence_id | This field requires the ID of the specific sequence you want to use. To obtain the sequence_id, navigate to the Sequences menu in your Aloware account. The sequence_id is typically displayed below the sequence name.  |
source | If the source of your contacts is a phone number, set this field to 'phone_number'. On the other hand, if the source is not a phone number but comes from other platforms such as Aloware, HubSpot, Zoho, Guesty, or Pipedrive, use the 'id' field instead. |
phone_number | This field is required if the source of your contacts is a phone number. Include the relevant phone number associated with the contact. |
id | This field is required if the source of your contacts is not a phone number but originates from platforms like Aloware, HubSpot, Zoho, Guesty, or Pipedrive. Provide the corresponding ID associated with the contact from the respective platform. |
Example POST URL
https://app.aloware.com/api/v1/webhook/sequence-enroll
Example POST Body
The following is an example JSON payload to enroll a contact in a sequence:
{
"api_token": "740A6C4E",
"sequence_id": "4567",
"force_enroll": true,
"source": "hubspot",
"id": 311,
"phone_number": "8181234567"
}Example POST Header
Accept: application/json
Content-Type: application/json
Response
HTTP 200 - Contact successfully enrolled in the sequence.
{
"message": "Contact is successfully enrolled in the sequence."
}HTTP 400 - Failure with a detailed response
{
"message": "Contact is already enrolled in a sequence."
}cURL Example
curl --location --request POST 'https://app.alodev.org/api/v1/webhook/sequence-enroll' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"api_token": "740A6C4E",
"sequence_id": "4567",
"force_enroll": true,
"source": "aloware",
"id": 142231
}
Disenroll a Contact from a Sequence
Endpoint
POST /api/v1/webhook/sequence-disenroll
Required Fields
api_token | This field requires your Aloware account API token. You can find this token within your Aloware account settings. |
source | If the source of your contacts is a phone number, set this field to 'phone_number'. On the other hand, if the source is not a phone number but comes from other platforms such as Aloware, HubSpot, Zoho, Guesty, or Pipedrive, use the 'id' field instead. |
phone_number | This field is required if the source of your contacts is a phone number. Include the relevant phone number associated with the contact. |
id | This field is required if the source of your contacts is not a phone number but originates from platforms like Aloware, HubSpot, Zoho, Guesty, or Pipedrive. Provide the corresponding ID associated with the contact from the respective platform. |
Example POST URL
https://app.aloware.com/api/v1/webhook/sequence-disenroll
Example POST Body
The following is an example JSON payload to disenroll a contact from a sequence:
{
"api_token": "740A6C4E",
"source": "hubspot",
"id": 311,
"phone_number": "8181234567"
}
Example POST Header
Accept: application/json
Content-Type: application/json
Response
HTTP 200 - Contact successfully disenrolled from all sequences
{
"message": "Contact is disenrolled from all sequences."
}
cURL Example
curl --location --request POST 'https://app.aloware.com/api/v1/webhook/sequence-disenroll'
\
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"api_token": "740A6C4E",
"source": "aloware",
"id": 142231
}'
If you have any further questions or need additional API functions, please don't hesitate to contact our support team at [email protected].