> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create queue



## OpenAPI

````yaml /api-reference/openapi.en.yaml post /queues
openapi: 3.0.3
info:
  title: Connecta DESK Public API
  version: 1.0.0
  description: >-
    Public API of Connecta DESK, available at `/api/v1`. Access uses a token
    generated in the tokens module. Each token has permissions per **module ×
    method**, and every list read is paginated.


    ## Authentication


    ```

    Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

    ```


    The token belongs to a **company**, not to a user. The company used is
    always the token's company, so sending `companyId` in the body has no
    effect. A missing, invalid, revoked or expired token gets the same `401`
    response.


    ## Order of checks


    1. **token** → `401`

    2. **active company** → `403`

    3. **API enabled on the plan** → `403 ERR_API_NOT_ENABLED` (does not apply
    to on-premise)

    4. **company rate limit** → `429`

    5. **token permission** → `403 ERR_API_FORBIDDEN_SCOPE`


    ## User ids


    Every user id in the API is the user's id **in this company**, the same one
    `GET /users` returns. This applies to what the API returns (`user.id`,
    `assignedTo.id`, `userCreated.id`) and to what it accepts (`userId`,
    `userIds`, `assignedToUserId` and the `{id}` in user routes).


    The same person can work in several companies, with a different name and
    profile in each one, and has a different id in each company.


    An id that does not belong to this company returns `404`, with the same
    message as an id that does not exist.


    ## Pagination


    Every list `GET` is paginated. The `meta` contains only `page`, `perPage`
    and `hasMore`, without the total number of records. To go through
    everything, keep advancing `page` while `hasMore` is `true`.


    ## Idempotency


    Optional on `POST`/`PUT`, through the `Idempotency-Key` header. If you
    repeat the call with the same key and the same body, you get the stored
    response (with `Idempotent-Replay: true`). With the same key and a different
    body, the response is `409`.
servers:
  - url: https://api.connectadesk.com/api/v1
    description: Production
security:
  - apiToken: []
tags:
  - name: contacts
    description: Contact records, extra fields and marketing source.
  - name: tickets
    x-displayName: Tickets
    description: Opening, transferring, closing and wrap-up of tickets.
  - name: messages
    description: Asynchronous sending and reading of messages.
  - name: tags
    description: Tags and their link to tickets.
  - name: queues
    description: Service queues and their agents.
  - name: wrapups
    description: Wrap-up types.
  - name: users
    description: Agents and administrators.
  - name: schedules
    description: Scheduled messages.
  - name: quick-messages
    description: Quick replies.
  - name: campaigns
    description: Bulk sending.
  - name: crm
    description: Boards, stages, cards and metrics.
  - name: channels
    description: Channels (read only).
  - name: reports
    description: Reports and dashboards.
  - name: products
    description: Product catalog, categories and sales performance.
  - name: custom-fields
    description: Custom fields for contacts and cards, plus company-wide global variables.
  - name: profiles
    description: Company permission profiles (read only).
  - name: webchat
    description: >-
      Native webchat from your own system: open a visitor session, send and read
      messages. The token needs the `webchat` scope (GET and POST).
paths:
  /queues:
    post:
      tags:
        - queues
      summary: Create queue
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - color
              properties:
                name:
                  type: string
                  description: Queue name.
                  example: Suporte
                color:
                  type: string
                  description: Tag color, in hexadecimal.
                  example: '#6941C6'
                greetingMessage:
                  type: string
                  description: >-
                    Message sent to the contact when the ticket enters this
                    queue.
                  example: Olá! Você está falando com o Suporte.
                outOfHoursMessage:
                  type: string
                  description: >-
                    Message sent to the contact outside the queue's business
                    hours.
                  example: Estamos fora do horário. Retornamos amanhã às 8h.
                userIds:
                  type: array
                  items:
                    type: integer
                  description: >-
                    Agents who work in this queue. The list you send replaces
                    the previous one. Use the user id in this company, the same
                    one `GET /users` returns. The same person has a different id
                    in each company they work in.
                  example:
                    - 3
                    - 9
                wrapupTypeIds:
                  type: array
                  items:
                    type: integer
                  description: Wrap-ups available when closing a ticket in this queue.
                  example:
                    - 12
                automaticDistribution:
                  type: boolean
                  description: >-
                    Automatically distributes this queue's tickets among the
                    agents who are online.
                orderQueue:
                  type: integer
                  description: >-
                    Position of the queue in the list. Lower numbers appear
                    first.
                  example: 1
                integrationId:
                  type: integer
                  description: Chatbot integration linked to the queue.
                  example: 4
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Queue'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  schemas:
    Queue:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          description: Display name.
        color:
          type: string
          description: Color in hexadecimal, with `#`.
          example: '#6941C6'
        greetingMessage:
          type: string
          nullable: true
          example: Olá! Você está falando com o Suporte.
        outOfHoursMessage:
          type: string
          nullable: true
          example: Estamos fora do horário. Retornamos amanhã às 8h.
        orderQueue:
          type: integer
          nullable: true
          example: 1
        automaticDistribution:
          type: boolean
          description: >-
            Automatically distributes this queue's tickets among the agents who
            are online.
        priority:
          type: integer
          nullable: true
        integrationId:
          type: integer
          nullable: true
          example: 4
        users:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
                description: Display name.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      example:
        id: 13
        name: Comercial
        color: '#0E7490'
        greetingMessage: Olá! Em que posso ajudar?
        outOfHoursMessage: Estamos fora do horário de atendimento.
        orderQueue: 1
        automaticDistribution: true
        priority: 2
        integrationId: null
        users:
          - id: 3
            name: Gabriel Goulart
          - id: 7
            name: Ana Souza
        createdAt: '2026-03-11T09:00:00.000Z'
        updatedAt: '2026-08-10T17:45:02.310Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Fixed error code, so your system can handle each case.
              example: ERR_API_FORBIDDEN_SCOPE
            message:
              type: string
            details: {}
  responses:
    UnprocessableEntity:
      description: >-
        The body is well formed, but a required field is missing or a value is
        not accepted. For example, `application` other than `contact`/`card`, an
        empty `orderedIds` or a blank `name`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ERR_API_VALIDATION
              message: >-
                O parâmetro `application` é obrigatório e aceita "contact" ou
                "card".
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: API token in the `sk_live_…` format.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.