Skip to main content

Reply in a conversation

POST 

/v1/agents/:agentId/conversations/:conversationId/messages

x-scope: "conversations:write"
x-rate-limit-per-minute: 20

Sends a text reply to the customer on the conversation's channel, as your team. It shows in the dashboard as written by the person who created the key. When the agent's ai_handoff_enabled is on, it pauses the AI for the agent's handoff window like any teammate's reply (when it is off, the AI keeps answering); when the pause ends, the AI may write once more if follow-ups are on for the channel (resumeConversationAi or ai_enabled: false prevents it). It never assigns the conversation. Refused before anything is saved (422): channel_not_supported on a channel Mojeeb can't send on (TikTok), and messaging_window_closed on WhatsApp, Facebook or Instagram when the customer hasn't written in the last 24 hours (on WhatsApp, send a template with sendWhatsAppTemplate instead). A refused reply isn't stored for its Idempotency-Key, and until 60 seconds after the refused request that key answers 409 idempotency_key_in_progress: once the cause has passed, send it again with a new key. The reply is sent after the response: it starts queued and its status moves on to sent, delivered, read or failed; follow it with getConversationMessage. On a website conversation it is stored as sent and appears in the open chat.

Request​

Responses​

The reply as saved (a replay of it when Idempotent-Replayed is true).

Response Headers
    X-Correlation-ID

    Correlation id for this request — paste into support tickets.

    Idempotent-Replayed

    Present and true when the response is a replay of a prior request.