klink-developers-logo

Automation Queue

Update

PATCH/api/v1/queues/{id}

Updates a queue. Send only the fields you want to change — omitted fields keep their current values, and the member list is left untouched.

Supplying agentIds or managerIds replaces that list. To add or remove one person, prefer Add Member / Remove Member, which are safer under concurrent updates.

Request

Authorization

Bearer Token

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

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

Path Params
  • idstringrequired

    Queue ID.

    Example:

Body Paramsapplication/json
  • namestringoptional

    Queue name. Must be unique in your workspace.

  • agentIdsarray[string]optional

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

  • managerIdsarray[string]optional

    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

200

OK

  • 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
404

Not Found

  • messagestringrequired
409

Conflict

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired