Sign in
Contact

Claim an unresolved contact address

Attaches a currently-unresolved contact address (contact_id is NULL) to the given contact. Idempotent if already claimed by the same contact. Default behavior (force absent or false): unchanged from before — returns 409 (Conflict) if the address is already claimed by a different, still-active (non-tombstoned) contact. Existing callers are unaffected. force: true (new): if the address is already claimed by a different, still-active contact, the claim overwrites that ownership instead of returning 409 — the previous owner's open ownership period is closed and a new one is opened for the requesting contact. Addresses owned by a tombstoned (soft-deleted) contact are repaired in place exactly as before, regardless of force.

post/contact_addresses/{id}/claim

Path parameters

idstring uuid required

The ID of the contact address to claim.

Request body

contact_idstring uuid required
forceboolean

When true, overwrite ownership even if the address is currently claimed by a different, still-active contact (no 409). Defaults to false, which preserves the original claim behavior. Has no effect when the address is unresolved or already owned by the requesting contact.

Example request

{
  "contact_id": "5e4a0680-eba3-4001-a000-000000000001"
}

Response

Address claimed successfully.

type'' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session'

Type of address.

targetstring

The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.

target_namestring

Address's name.

namestring

Optional label for this address.

detailstring

Additional notes about this address.

idstring uuid

Unique identifier for the address.

contact_idstring uuid

Unique identifier of the contact this address belongs to.

customer_idstring uuid

Unique identifier of the customer this address belongs to.

is_primaryboolean

Indicates if this is the primary address for the given type.

tm_createstring date-time

Timestamp when the address was created.

Example response

{
  "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"
}

Changes

Changed in 3 of the 54 revisions of this API.112

  • d5569b31541111See the full diff
    • ●

      added the new web_session enum value to the allOf[CommonAddress]/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property force

      new-optional-request-property

  • 505b7c32e9101See the full diff
    • ○

      endpoint added

      endpoint-added

  • 995c56ba92191See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog