klink-developers-logo

Automation Queue

Remove Member

DELETE/api/v1/queues/{id}/members/{userId}

Removes a user from a queue. Their other queue memberships are unaffected, and the account itself is not deleted.

A user may be both an agent and a manager of the same queue. Pass membershipRole to remove only that role and keep the other; omit it to remove every membership the user holds on the queue.

Removing someone who does not hold that membership returns 404.

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:

  • userIdstringrequired

    User ID to remove.

    Example:

Query Params
  • membershipRolestringoptional

    Which membership to remove: agent or manager. Omit to remove the user from the queue entirely (both roles).

    Allowed values:"agent", "manager"

    Example:agent

Responses

200

OK

  • requestIdstringrequired

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

  • messagestringrequired
401

Unauthorized

  • messagestringrequired
404

Not Found

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired