Skip to main content
POST
social.post.unpublish

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
ref
string
required

The ref returned by social.post.publish or a social.posts.list row.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
platform
enum<string>
required

Which platform to take the post down from.

Available options:
x,
threads,
facebook,
linkedin,
youtube,
pinterest,
reddit,
bluesky,
googlebusiness,
telegram
accountId
string

The connected account to remove it from, from social.accounts.list. Required when the post was published to several accounts on this platform.

Required string length: 1 - 256

Response

The result

removed
boolean
required

Always true; a failure is an error instead.