VOvoipbin
Service Agent

Remove a pin

Changed on

Removes a pin of the calling agent and returns the removed pin. The pin of another agent is reported as not found.

delete/service_agents/talk_pins/{id}

Request

Path parameters

idstring uuid required
Example:6f1c1a52-8d3b-4c1e-9a5e-0b7f2d9a1c10

The pin ID returned from POST /service_agents/talk_pins or GET /service_agents/talk_pins.

Response

The removed pin.

idstring uuid

The pin ID returned from POST /service_agents/talk_pins or GET /service_agents/talk_pins.

target_type'chat' | 'message'

What a pin points to.

target_idstring uuid

The chat ID returned from GET /service_agents/talk_chats, or the message ID returned from GET /service_agents/talk_messages, depending on target_type.

chat_idstring uuid

The chat the pinned chat or message belongs to. The ID is returned from GET /service_agents/talk_chats.

tm_createstring date-time

Timestamp when the pin was created.

Example response

{
  "id": "6f1c1a52-8d3b-4c1e-9a5e-0b7f2d9a1c10",
  "target_type": "message",
  "target_id": "0d4b7a3e-2f5c-4b8e-8a21-9c3e6f1d7a42",
  "chat_id": "9a2b5c7d-1e3f-4a6b-8c9d-0e1f2a3b4c5d",
  "message": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
    "owner_type": "agent",
    "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
    "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
    "parent_id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f9a0b1c2d",
    "type": "normal",
    "text": "Hello team, any updates on the project?",
    "medias": [
      {
        "type": "file",
        "address": {
          "type": "tel",
          "target": "+14155551234",
          "target_name": "John Smith",
          "name": "Main Office",
          "detail": "Primary contact number"
        },
        "agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
        "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "link_url": "https://example.com/document.pdf"
      }
    ],
    "metadata": {
      "reactions": [
        {
          "emoji": "👍",
          "owner_type": "agent",
          "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
          "tm_create": "2026-01-15T09:30:00.000000Z"
        }
      ]
    },
    "tm_create": "2026-01-15T09:30:00.000000Z",
    "tm_update": "2026-01-16T14:20:00.000000Z",
    "tm_delete": "2026-01-17T18:45:00.000000Z"
  },
  "tm_create": "2026-11-02T09:15:30.123456Z"
}

Changes