Skip to main content
PATCH
Update a Queue

Authorizations

Authorization
string
header
required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Path Parameters

qid
string
required

Queue ID

Body

application/json

Fields to change

active
boolean

False pauses the Queue, true resumes it.

Example:

true

is_default
boolean

Only true is accepted: it makes this the Brand's default Queue.

Example:

true

name
string

New name.

Example:

"Evenings"

reshuffle_existing
boolean

Set true to move the Queue's posts onto the new slots, in their current order. The response then carries reshuffled_count.

Example:

false

slots
object[]

Weekly posting times. Replaces the whole list when sent; omit to keep the current list.

timezone
string

New IANA timezone.

Example:

"Europe/Paris"

Response

OK

active
boolean

False when the Queue is paused: no new post can join it.

Example:

true

brand_id
string

ID of the Brand the Queue belongs to.

created_at
string

When the Queue was created.

id
string

Queue ID.

Example:

"que_01J9Z8Y7X6W5V4T3S2R1Q0P9N8"

is_default
boolean

True for the Brand's default Queue, the one queue_id "default" refers to.

Example:

true

name
string

Queue name.

Example:

"Evenings"

reshuffled_count
integer

Number of queued posts moved to the new times. Present only when the request sent reshuffle_existing: true.

slots
object[]

Weekly posting times, sorted by day (Monday first) then time.

timezone
string

IANA timezone the slots are expressed in.

Example:

"Europe/Paris"

updated_at
string

When the Queue was last changed.