Skip to main content
POST
chat.message.update

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_-]+$
messageId
string
required

Stored message ID in this channel.

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

Replacement message text, 1 to 5000 characters; personal data.

Required string length: 1 - 5000
kind
enum<string>
default:group

Group conversation or public open channel.

Available options:
group,
open

Response

The result

messageId
string
required

Stored message ID in your connected chat app.

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

Channel containing this message.

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

Text, attachment, or system message. File contents are not included.

Available options:
text,
file,
admin
text
string

Message text; personal data. File contents and hosted links are omitted.

Maximum string length: 5000
senderId
string

Sender's own user key; absent for system messages.

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

Sender's display name; personal data.

Maximum string length: 256
parentMessageId
string

Parent message ID when this is a reply.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
sentAt
string<date-time>

When the message was sent, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updatedAt
string<date-time>

When the message was last updated, in UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$