Passer au contenu principal
POST
Schedule a follow-up

Autorisations

Authorization
string
header
requis

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Corps

application/json
conversation_id
string
requis

The conversation to follow up (GET /conversations)

type_id
string
requis

GET /follow-up-types

Exemple:

"FUI-XXXXX"

reason
string
requis

What is expected from the contact; the AI writes each follow-up from it

Maximum string length: 2000
message
string | null

Fixed text to send instead of the AI-written one

Maximum string length: 4096
scheduled_at
string<date-time> | null

First follow-up; by default after the delay of the type

campaign_id
string | null

The campaign the follow-up belongs to

Réponse

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Exemple:

true

code
integer
Exemple:

1000

message
string
Exemple:

"Request success."

body
object

A follow-up on a conversation: messages sent to the contact until they reply, or until the maximum of the type is reached.

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false