Skip to main content
POST
Send an insight card

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Headers

Idempotency-Key
string

1 to 255 visible ASCII characters (no spaces) naming this send, given once. A 201 is stored for 24 hours, and a replay returns it with Idempotent-Replay: true. The stored request covers the call and the body, so the same key for another call or with another body is 422 IDEMPOTENCY_KEY_REUSED. That 422, and a 409 INSIGHT_CARDS.IDEMPOTENCY_KEY_IN_USE while the first request is still running, leave the key with the request that holds it. Any other refusal leaves the key unused, so a retry with the same key runs again. Keys are per company. See Retries in the operation description.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$
Example:

"crm-sync-4821-7c1d"

Path Parameters

callUuid
string<uuid>
required

The call uuid: 8-4-4-4-12 hexadecimal digits, in any letter case. Any other value is 400 VALIDATION.INVALID_PARAMETER with target: "callUuid".

Example:

"3f2b8c1e-6a4d-4e7b-9c05-1d2e3f4a5b6c"

Body

application/json

An insight card. Unknown fields are refused here and in every block.

title
string
required

The card's title, 1 to 120 characters, not blank.

Required string length: 1 - 120
Example:

"Acme Corp"

icon
enum<string>

The card's icon. Left out, the card shows the default icon.

Available options:
user,
briefcase,
file-text,
tag,
zap
blocks
(Field list · object | Text · object | Link · object | Chip group · object | Metric · object | Ticket reference · object)[]

Up to 20 blocks. Left out or empty, the card shows its title alone. Every block has a kind, which sets its other fields, a required title, and optional externalUrl and empty.

Maximum array length: 20

Label and value rows, such as the fields of a record.

Example:

Response

The card was shown to the agent on the call (delivery: delivered) or kept for the agent who answers (delivery: pending). The answer holds none of the card's content.

The answer to a send.

data
object
required

A card you sent. It holds none of the card's content.

requestId
string
required

The request id. A replay returns the first request's.