Posts

Delete post on platforms

Deletes a published post from one or more social media platforms without removing it from the database. The deletion happens asynchronously via a background job; if no targeting parameter is provided, the post is deleted from all published platforms.

post/api/posts/{id}/delete_on_platform

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/posts/{id}/delete_on_platform
  • Auth
    HTTP bearer

Path parameters

idstring required

Post id

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

Headers

Idempotency-Keystring

Optional idempotency key (up to 255 characters; a UUID is ideal). Retrying a successful write with the same key replays the original response (with an Idempotent-Replay: true header) instead of executing again. Stored responses are kept for 24 hours; only 2xx responses are stored.

Request body

post_profile_idstring

ID of a specific post profile. Resolves to the underlying profile and deletes across the entire thread

profile_idstring

ID of a profile. Deletes all post profiles for this profile on the post

networkstring

Network name (e.g. twitter, facebook). Deletes all post profiles for this network on the post

profile_group_idstring

Scope the lookup to a specific profile group

Response

Deletion started

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.