Add Member

POST/api/v1/queues/{id}/members

Adds one user to a queue, as either an agent or a manager.

Use this rather than Update when adding a single person: it will not disturb the other members and is safe when several additions happen at once.

A user may hold both roles on the same queue: add them twice with different membershipRole values. Adding someone who already holds that exact role returns 409; use Remove Member with membershipRole to drop one role without the other.

If the queue assigns automatically, a new agent starts receiving waiting conversations right away.

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

userIdstringrequired
User ID from User → Listing.
membershipRolestringrequired
agent receives conversations; manager supervises the queue.

Allowed values:"agent", "manager"

Responses

201

Created

requestIdstringrequired
Unique ID for this request. Quote it when reporting a problem.
dataobjectrequired
Child attributes
- userIdstringrequired
- namestringrequired
- emailstringrequired
- membershipRolestringrequired
  agent receives conversations from the queue; manager supervises it.
  
  Allowed values:"agent", "manager"

401

Unauthorized

messagestringrequired

404

Not Found

messagestringrequired

409

Conflict

messagestringrequired

429

Too Many Requests

messagestringrequired

Request

curl -X POST "https://apigw.klinkcx.com/api/v1/queues/{id}/members" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "string",
  "membershipRole": "agent"
}'

Response

{
  "requestId": "string",
  "data": {
    "userId": "string",
    "name": "string",
    "email": "string",
    "membershipRole": "agent"
  }
}