POpostproxy
Queues

Update queue

Updates a queue's settings, timeslots, or enabled state. Any changes to timezone or timeslots will trigger a rearrangement of all queued posts.

patch/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.

Request body

Response

The updated queue

idstring

Queue identifier (ID)

namestring

Queue name

descriptionstring nullable

Optional description

timezonestring

IANA timezone name (e.g. America/New_York)

enabledboolean

Whether the queue is active. When paused (false), posts in the queue will not be published even if their scheduled time arrives

jitterinteger

Random offset in minutes (+/-) applied to scheduled times (0-60, default: 0)

profile_group_idstring

Associated profile group (ID)

posts_countinteger

Number of currently scheduled posts

Changes

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