VOvoipbin
Service Agent

Star a contact

Changed on

Star the contact for the calling agent. A star is private to the agent: other agents never see it. The call is idempotent: starring a contact that is already starred returns the existing star with its original tm_create. A contact that does not exist, is deleted, or belongs to another customer returns 404.

put/service_agents/contacts/{id}/star

Request

Path parameters

idstring uuid required
Example:b2c3d4e5-f6a7-8901-bcde-f12345678901

The contact ID returned from GET /service_agents/contacts.

Response

The contact is starred.

contact_idstring uuid required

The contact ID returned from GET /service_agents/contacts.

starredboolean required

Whether the calling agent has starred the contact.

tm_createstring date-time

When the contact was starred. Absent when starred is false.

Example response

{
  "contact_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "starred": true,
  "tm_create": "2026-11-02T09:15:30.123456Z"
}

Changes