Queues

Delete queue

Deletes a queue. Posts that were in the queue will have their queue reference removed but will not be deleted.

delete/api/post_queues/{id}

Request

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

Path parameters

idstring required

Queue 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.

Response

Queue deleted

deletedboolean

Example response

{
  "deleted": true
}

Changes

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