Sign in

v51

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

Update address on contact (service agent)

Update an existing address on the contact as a service agent.

put/service_agents/contacts/{id}/addresses/{address_id}

Path parameters

idstring uuid required
Example:5e4a0680-eba3-4001-a000-000000000001

The ID of the contact.

address_idstring uuid required
Example:5e4a0680-eba3-4001-a000-000000000002

The ID of the address returned from POST /service_agents/contacts/{id}/addresses.

Request body

targetstring

The updated address value.

namestring

Optional human-readable label for this address.

detailstring

Optional free-form notes about this address.

is_primaryboolean

Whether this is the primary address for the given type.

Example request

{
  "target": "+155****9999",
  "name": "Main Office",
  "detail": "Primary contact number",
  "is_primary": true
}

Response

Address updated successfully.

idstring uuid

Unique identifier for the contact.

customer_idstring uuid

Unique identifier of the associated customer.

first_namestring

First name of the contact.

last_namestring

Last name of the contact.

display_namestring

Display name of the contact.

companystring

Company name associated with the contact.

job_titlestring

Job title of the contact.

source'manual' | 'import' | 'api' | 'sync'

Source of the contact.

external_idstring

External identifier for the contact.

notesstring

Free-form notes about the contact. May include call summaries, preferences, or special instructions.

tag_idsstring[]

List of tag IDs associated with the contact.

tm_createstring date-time

Timestamp when the contact was created.

tm_updatestring date-time

Timestamp when the contact was last updated.

tm_deletestring date-time

Timestamp when the contact was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "first_name": "John",
  "last_name": "Smith",
  "display_name": "John Smith",
  "company": "Acme Corporation",
  "job_title": "Software Engineer",
  "source": "manual",
  "external_id": "CRM-12345",
  "notes": "Prefers morning calls. VIP account - escalate to senior support immediately.",
  "addresses": [
    {
      "type": "tel",
      "target": "+14155551234",
      "target_name": "John Smith",
      "name": "Main Office",
      "detail": "Primary contact number",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "contact_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "customer_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "is_primary": true,
      "tm_create": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "tag_ids": [
    "b1a2c3d4-e5f6-7890-abcd-ef1234567890"
  ],
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}