ConversationBan
The customer's ban, for this conversation's customer identity in this inbox only. Absent when the customer isn't banned or the ban has expired.
Properties
- Name
bannedAt- Type
- string
- required
When the customer was banned.- Name
bannedBy- Type
- ConversationBanActor
- required
- Name
expiresAt- Type
- string
When the ban ends. Absent when it lasts until the customer is unbanned.- Name
reason- Type
- string
Why the customer was banned. Absent when no reason was given.
Used by
- POSTSend message/messages
- GETGet message/messages/{id}
- GETList conversations/conversations
- GETGet conversation/conversations/{id}
- GETList conversation messages/conversations/{id}/messages
- POSTSend message in conversation/conversations/{id}/messages
- POSTMark conversation as read/conversations/{id}:markRead
- POSTClose conversation/conversations/{id}:close
- POSTBan conversation customer/conversations/{id}:ban
- POSTUnban conversation customer/conversations/{id}:unban
- POSTWebhook payloads{configured webhook URL}