POST
/
crm
/
card

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required

ID of the Agent to associate with the conversation.

stepId
string | null

ID of the CRM Step. Required if scenarioId and stepIndex are not provided.

scenarioId
string | null

ID of the CRM Scenario (used with stepIndex if stepId is omitted).

stepIndex
integer | null

Index of the step within the scenario (used with scenarioId if stepId is omitted).

name
string | null

Contact's first name (used if creating a new contact).

phone
string | null

Contact's phone number. Used to resolve or create contact and WhatsApp conversation.

email
string | null

Contact's email. Used to resolve or create contact if phone is not provided.

tags

Tags to attach to the conversation (e.g. ["VIP", "LEAD"] or "VIP, LEAD").

isAiEnabled
boolean | null

Whether AI responses are enabled for the conversation.

status
enum<string> | null

Conversation status.

Available options:
UNRESOLVED,
RESOLVED,
HUMAN_REQUESTED
priority
enum<string> | null

Conversation priority.

Available options:
LOW,
MEDIUM,
HIGH
assigneeId
string | null

Membership ID or User ID of the assigned team member.

assigneeEmail
string | null

Email of the assigned team member.

shouldSendInitialMessage
boolean
default: false

Whether to send the initial message defined on the CRM step upon adding the card.

Response

200 - application/json
success
boolean
contact
object
conversation
object
stepId
string
scenarioId
string