Service Agent

Unassign the conversation

Changed on

Removes the current owner from the conversation. Admin and manager callers may unassign any conversation. The owning agent may unassign themselves. Returns 403 if the caller is neither an admin/manager nor the current owner.

post/service_agents/conversations/{id}/unassign

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/service_agents/conversations/{id}/unassign
  • Auth
    none declared

Path parameters

idstring uuid required
Example:828e75ba-ed24-11ec-bbf2-7f0e56ac76f1

The unique identifier of the conversation. Returned from the GET /service_agents/conversations response.

Response

Conversation after unassignment.

idstring uuid

The unique identifier of the conversation.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

owner_typestring

Type of the conversation owner.

owner_idstring uuid

The unique identifier of the conversation owner. Returned from the corresponding owner resource endpoint (e.g., GET /agents).

account_idstring uuid

The unique identifier of the conversation account. Returned from the GET /conversation_accounts response.

namestring

Name of the conversation.

detailstring

Detailed information about the conversation.

type'' | 'message' | 'line' | 'whatsapp' | 'email'

Type of the conversation.

dialog_idstring

The identifier of the referenced conversation transaction. For Line, this is the chatroom ID.

tm_createstring date-time

Timestamp when the conversation was created.

tm_updatestring date-time

Timestamp when the conversation was last updated.

tm_deletestring date-time

Timestamp when the conversation was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "owner_type": "agent",
  "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Customer Support Chat",
  "detail": "Support conversation with customer",
  "type": "message",
  "dialog_id": "chatroom-abc123",
  "self": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "peer": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Changes

  • d5569b315411Revision changes
    • warning

      added the new web_session enum value to the / response property for the response status

    • warning

      added the new web_session enum value to the / response property for the response status

  • c7eb634e776fRevision changes
    • warning

      added the new email enum value to the response property for the response status