Sequence API

Enroll and disenroll contacts in sequences.

Add contacts to an Aloware sequence, or take them out of every sequence, with a single API call. Use it to start follow-up automatically when something happens in your CRM or app, and to stop it when it should end.

Where to find it: Integrations menu > Sequences API in Aloware
Method: POST
Auth: your account API token, sent in the request body as api_token
Format: JSON in, JSON out
Contact: identified by phone number or by its ID in Aloware, HubSpot, Zoho, Guesty or Pipedrive

Enroll a contact

Endpoint

POST /api/v1/webhook/sequence-enroll

Fields

Pick how you identify the contact with source, then send either phone_number or id to match.

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.

Request example

Full URL:

https://app.aloware.io/api/v1/webhook/sequence-enroll

This body enrolls a HubSpot contact in sequence 4567:

{
  "api_token": "[API_TOKEN]",
  "sequence_id": "4567",
  "force_enroll": true,
  "source": "hubspot",
  "id": 311,
  "phone_number": "8181234567"
}

Headers:

Accept: application/json
Content-Type: application/json

Responses

200: the contact is now in the sequence.

{
  "message": "Contact is successfully enrolled in the sequence."
}

400: the enrollment failed, and the message says why. Here, the contact was already in a sequence.

{
  "message": "Contact is already enrolled in a sequence."
}

cURL example

This one enrolls a contact by its Aloware ID:

curl --location --request POST 'https://app.aloware.io/api/v1/webhook/sequence-enroll' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "api_token": "[API_TOKEN]",
    "sequence_id": "4567",
    "force_enroll": true,
    "source": "aloware",
    "id": 142231
}

Disenroll a contact

This removes the contact from all sequences, not just one, so there is no sequence_id to send.

Endpoint

POST /api/v1/webhook/sequence-disenroll

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.

Request example

Full URL:

https://app.aloware.io/api/v1/webhook/sequence-disenroll

This body takes a HubSpot contact out of its sequences:

{
  "api_token": "[API_TOKEN]",
  "source": "hubspot",
  "id": 311,
  "phone_number": "8181234567"
}

Headers:

Accept: application/json
Content-Type: application/json

Responses

200: the contact has left every sequence.

{
  "message": "Contact is disenrolled from all sequences."
}

cURL example

Disenrolling by Aloware ID:

curl --location --request POST 'https://app.aloware.io/api/v1/webhook/sequence-disenroll'
 
 \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "api_token": "[API_TOKEN]",
    "source": "aloware",
    "id": 142231
}'

Need another endpoint?

For other API functions or questions about this one, email support@aloware.com.

Need a hand?

Our support team can help you set this up.

Contact support