Skip to main content
POST
/
api
/
queues
POST /api/queues
curl --request POST \
  --url https://api.sippet.ai/api/queues \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "relationships": {},
    "type": "Queue"
  }
}
'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "queue_name": "<string>",
      "strategy": "<string>",
      "max_wait_time": 123,
      "moh_sound": "<string>"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "<string>",
          "type": "<string>",
          "meta": {}
        }
      }
    }
  },
  "included": [
    "<unknown>"
  ],
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://sippet.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

JWT for bearer authentication

Query Parameters

include
string

Relationship paths to include in the response

Pattern: ^()(,())*$
fields
object

Limits the response fields to only those listed for each type

Example:
{
"Queue": "id,queue_name,strategy,moh_sound,max_wait_time"
}

Body

application/vnd.api+json

Request body for the /queues operation on Queue resource

data
object
required

Response

Success

data
object

A "Resource object" representing a Queue

included
any[]
meta
object