Skip to main content
POST
social.inbox.conversation.delete

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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string
required

Connected account from social.accounts.list.

Required string length: 1 - 256
conversationId
string
required

Conversation from social.inbox.conversations.list.

Required string length: 1 - 256
dryRun
boolean
default:true

Preview without deleting. Set false to permanently erase the stored conversation and its messages.

Response

The result

deleted
boolean
required

Whether the stored conversation was deleted.

deletedMessages
integer

Number of stored messages erased.

Required range: 0 <= x <= 9007199254740991