v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Agent

Update an agent's tag IDs

Update an agent's tag IDs and return updated details.

put/agents/{id}/tag_ids

Path parameters

idstring required

The ID of the agent.

Request body

tag_idsstring[]

Response

Successful response.

idstring uuid

The unique identifier of the agent.

customer_idstring uuid

The unique identifier of the customer who owns this agent. Returned from the GET /customers response.

usernamestring

Agent's login username, typically an email address.

namestring

Display name of the agent.

detailstring

Additional detail or notes about the agent.

ring_method'ringall' | 'linear'

Method used to ring the agent for incoming calls.

Current availability status of the agent.

permission0 | 65535 | 1 | 15 | 16 | 32 | 64 | 240

Permission type

tag_idsstring[]

List of tag IDs assigned to this agent. Returned from the POST /tags or GET /tags response.

direct_hashstring

Hash for direct access via SIP URI sip:direct.<hash>@sip.voipbin.net. Returned from the resource's direct_hash field.

tm_createstring date-time

Timestamp when the agent was created.

tm_updatestring date-time

Timestamp when the agent was last updated.

tm_deletestring date-time

Timestamp when the agent was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "username": "agent@example.com",
  "name": "John Smith",
  "detail": "Senior support agent",
  "ring_method": "ringall",
  "status": "available",
  "permission": 64,
  "tag_ids": [
    "b1a2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "addresses": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number"
    }
  ],
  "direct_hash": "a8f3b2c1d4e5",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T10:00:00.000000Z"
}