Send message to a contact

Initiates a conversation by sending the first message (either freeform or using a template) to a specified phone number. Can be scheduled.

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

The ID of the customer account.

Body Params

Requires either 'freeform' or 'template' to be provided.

string
required

The recipient's phone number in international format (e.g., +1xxxxxxxxxx).

freeform
object

Represents a freeform message. At least one of text, imageUrl, videoUrl or documentUrl must be present.

template
object

Represents a message template identifier.

date-time

ISO 8601 timestamp to schedule the message sending. Optional.

providedProfile
object

Contact profile information. This object supports any custom fields
beyond the standard ones (firstName, lastName, email).
Custom fields can be defined in the assistant's providedProfileConfig.

utm
object

UTM parameters for tracking.

crm
object

CRM-related information for the contact. Use this to link AISA contacts
with records in your external CRM system (e.g., HubSpot, Salesforce, Pipedrive).

tags
array of strings

List of tags to associate with the contact.

tags
Responses
200

Message sending task successfully created/scheduled.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json