Skip to main content
POST
Create a Queue

Authorizations

Authorization
string
header
required

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

Body

application/json

Queue definition

active
boolean

Set false to create the Queue paused. Defaults to true.

Example:

true

brand_id
string

ID of the Brand to create the Queue on. Required.

is_default
boolean

Set true to make this the Brand's default Queue. The Brand's first Queue is always the default.

Example:

false

name
string

Queue name. Required.

Example:

"Evenings"

slots
object[]

Weekly posting times, 1 to 100. Required.

timezone
string

IANA timezone the slots are expressed in. Required.

Example:

"Europe/Paris"

Response

Created

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"

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.