klink-developers-logo

Automation Queue

Create

POST/api/v1/queues

Creates an automation queue — the mechanism that routes incoming conversations to agents.

agentIds and managerIds each need at least one user; use User → Listing to find IDs. The same person may be both.

Set maximumAssignPerAgent deliberately: omitted, it defaults to 1, so each agent holds a single conversation at a time.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Body Paramsapplication/json
  • namestringrequired

    Queue name. Must be unique in your workspace.

  • agentIdsarray[string]required

    Users who receive conversations from this queue. At least one.

  • managerIdsarray[string]required

    Users who supervise this queue. At least one.

  • descriptionstring | nulloptional
  • emojistringoptional

    Icon shown beside the queue name. Defaults to 📥.

  • distributionStrategystring | nulloptional

    How conversations are handed out: round-robin in turn, fewest-assignments to the least busy agent, random, or notify-all to alert everyone.

    Allowed values:"round-robin", "fewest-assignments", "random", "notify-all", null

  • maximumAssignPerAgentinteger | nulloptional

    Concurrent conversations per agent. Defaults to 1 when omitted — set it explicitly for anything busier.

  • useGlobalAgentCapacitybooleanoptional

    Use each agent's own capacity instead of the queue limit.

  • offlineAssignmentbooleanoptional

    Assign conversations to agents who are offline.

  • autoAssignboolean | nulloptional

    Hand out conversations automatically. When false, a supervisor assigns them manually.

Responses

201

Created

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataobjectrequired
    Child attributes
    • idstringrequired
    • namestringrequired
    • descriptionstring | nullrequired
    • emojistringrequired
    • distributionStrategystring | nullrequired

      Allowed values:"round-robin", "fewest-assignments", "random", "notify-all", null

    • maximumAssignPerAgentinteger | nullrequired
    • useGlobalAgentCapacitybooleanrequired
    • offlineAssignmentbooleanrequired
    • autoAssignboolean | nullrequired
    • membersarray[object]required
      Child attributes
      • userIdstringrequired
      • namestringrequired
      • emailstringrequired
      • membershipRolestringrequired

        agent receives conversations from the queue; manager supervises it.

        Allowed values:"agent", "manager"

    • createdAtstringrequired
    • updatedAtstringrequired
401

Unauthorized

  • messagestringrequired
409

Conflict

  • messagestringrequired
422

Unprocessable Entity

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired