API Reference

Create a chat conversation by phone number

post
https://api.getaisa.ai/customers//conversations

Resolves or creates a WhatsApp contact by phoneNumber, creates a new ChatConversation, and optionally sends the first message. Requires chat conversations to be enabled for the customer, otherwise responds with 400.

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

Contact phone number. Required only for /customers/{customerId}/conversations.

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).

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.

scheduledEvent
object

Initial scheduled event for this conversation.

utm
object

UTM parameters for tracking.

tags
array of strings
tags
string
enum

Overrides customer carry-over behavior for this conversation.

Allowed:
carryOverFields
array of strings

Profile fields to carry over. The default implementation carries firstName, lastName and email.

carryOverFields
boolean

If true, preserves the current contact-level assistant lock. By default, creating a conversation unlocks the assistant.

firstMessage
object

Optional first message sent after creating the conversation. When provided, either 'freeform' or 'template' is required; otherwise the request fails with 400.

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?