v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

contacts

Create Phone Number

Use this endpoint to add a phone number to the list of phone numbers for a specific contact.

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

post/contacts/{contactId}/phone-numbers

Path parameters

contactIdstring uuid required

The contact's unique identifier

Request body

idstring uuid

The GUID of the Phone Number.

_linkstring

The URI of the Phone Number.

numberstring

10 digit phone number.

extstring

type'Home' | 'Mobile' | 'Work'

primaryboolean

Is this phone number the primary phone number for the related entity?

smsOptOutboolean nullable

This value specifies if SMS messaging is active for this contact number.

Example request

{
  "id": "b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
  "_link": "https://api.acculynx.com/api/v2/contacts/7f008cca-9789-44c3-afdf-7ec2e005c267/phone-numbers/b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
  "type": "Home"
}

Response

Created

idstring uuid

The GUID of the Phone Number.

_linkstring

The URI of the Phone Number.

Example response

{
  "id": "b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
  "_link": "https://api.acculynx.com/api/v2/contacts/7f008cca-9789-44c3-afdf-7ec2e005c267/phone-numbers/b2830ef6-c5ff-44ca-a3b9-aa767f50a04b"
}