Skip to main content
POST
chat.channel.typing.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
channelId
string
required

Channel ID in your connected chat app.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
userId
string
required

User's own key in your connected chat app.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
kind
enum<string>
default:group

Group conversation or public open channel.

Available options:
group,
open

Response

The result

acknowledged
boolean
required

The action was accepted; this does not promise delivery to connected devices.