Posts

Delete post

Deletes a post from the database. By default this does not remove the post from social media platforms; pass delete_on_platform=true to also delete it from platforms first.

delete/api/posts/{id}

Request

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

Path parameters

idstring required

Post id

Query parameters

delete_on_platformboolean

If true, also deletes the post from all published platforms before removing it from the database

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.

Response

Post deleted

deletedboolean

Example response

{
  "deleted": true
}

Changes

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