Sign in
Contact

Create a contact address

Create a new address (tel or email) for a contact. If contact_id is omitted, creates an unresolved address (not yet attached to any contact) for the authenticated customer's unresolved pool; such an address cannot be primary.

post/contact_addresses

Request body

contact_idstring uuid

The ID of the contact to add the address to. Omit to create an unresolved address in the customer's unresolved pool.

type'tel' | 'email' | 'web_session' required

Address type. 'tel' for phone numbers, 'email' for email addresses, 'web_session' for a webchat visitor's continuity token (temporary/internal attribution address; not exposed on the Contact.Addresses field).

targetstring required

The address value. E.164 format for tel, email address for email.

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 contact.

Example request

{
  "contact_id": "5e4a0680-eba3-4001-a000-000000000001",
  "type": "tel",
  "target": "+155****4567",
  "name": "Main Office",
  "detail": "Primary contact number",
  "is_primary": true
}

Response

Address created 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 5 of the 54 revisions of this API.266

  • d5569b31541111See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

      added the new web_session enum value to the request property type

      request-property-enum-value-added

  • 505b7c32e9103See the full diff
    • ○

      added the new optional request property detail

      new-optional-request-property

    • ○

      added the new optional request property name

      new-optional-request-property

    • ○

      the request property contact_id became optional

      request-property-became-optional

  • 2ad05734434b151See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 201

      response-body-type-changed

    • ●

      removed the optional property id from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property is_primary from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property target from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property tm_create from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property type from the response with the 201 status

      response-optional-property-removed

    • ○

      added CommonAddress subschema #2 to the response body allOf list for the response status 201

      response-body-all-of-added

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

  • b1372a7d8ce61See 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