Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Headers

Idempotency-Key
string

Optional, up to 255 characters. Retry with the same key after a network error and you get the first answer back instead of the change being made twice (kept 10 minutes). Same key with a different body: 422 IdempotencyKeyReused. While the first request still runs: 409 IdempotencyKeyInProgress.

Maximum string length: 255
Example:

"0b6f3c1e-retry-1"

Path Parameters

voiceAgentId
string<uuid>
required

ID of the voice agent.

Example:

"fc6f158b-24c2-45a6-957b-c57c0a8979b5"

Body

application/json
note
string

A note for the reviewers, up to 500 characters.

Maximum string length: 500
Example:

"New opening line for Saudi callers."

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"success"

data
object

A member's draft of the agent.