Skip to main content
POST
/
v1
/
channels
/
{id}
/
conversation
Start conversation on channel
curl --request POST \
  --url https://api.timelyai.com.br/v1/channels/{id}/conversation \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "to": "<string>",
  "message": "<string>"
}
'
{
  "data": {
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
x-api-key
string
header
required

API key obtained from the dashboard

Path Parameters

​
id
string<uuid>
required

Channel ID

Body

application/json
​
to
string
required

Recipient (phone, email, etc.)

​
message
string
required

Initial message

Response

Conversation started

​
data
object