POST
Start a conversation

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>. Create keys in the Cerium dashboard. Keep them on your servers only.

Body

application/json
body
string
required
Required string length: 1 - 20000
customerId
string
required

The customer the conversation is with.

Maximum string length: 40
Example:

"prt_8271"

idempotencyKey
string

A unique key for this attempt. Sending it again returns the first message instead of adding another.

Required string length: 1 - 64
Example:

"order-1042-msg-1"

attachments
object[]
Maximum array length: 10

Response

This idempotencyKey was already used. The first message is returned and nothing new is added.

message
string
Example:

"Message received."

status
string
Example:

"success"

data
object