---
title: "Create Phone Number"
method: POST
path: "/contacts/{contactId}/phone-numbers"
tags: ["contacts"]
---

# Create Phone Number

`POST /contacts/{contactId}/phone-numbers`

## Request

- Base URL: `https://api.acculynx.com/api/v2`
- URL: `https://api.acculynx.com/api/v2/contacts/{contactId}/phone-numbers`
- Auth: HTTP bearer

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.

## Path parameters

- `contactId` string, uuid, required

## Request body

- PhoneNumberPost
  - `id` string, uuid: The GUID of the Phone Number.
  - `_link` string: The URI of the Phone Number.
  - `number` string: 10 digit phone number.
  - `ext` string
  - `type` 'Home' | 'Mobile' | 'Work'
  - `primary` boolean: Is this phone number the primary phone number for the related entity?
  - `smsOptOut` boolean, nullable: This value specifies if SMS messaging is active for this contact number.

## Response `201`

Created

- PhoneNumberLink
  - `id` string, uuid: The GUID of the Phone Number.
  - `_link` string: The URI of the Phone Number.

## Other responses

- `400`: The request was malformed or contained invalid field values. Check the error response body for details.
- `401`: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
- `404`: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.
- `429`: The rate limit for this operation has been exceeded. Use the RateLimit-* response headers to determine when you can retry.

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)