---
title: "Phones.create"
method: POST
path: "/entities/Phones"
tags: ["Phone"]
---

# Phones.create

`POST /entities/Phones`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Phones`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Phones/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a Phone record.

## Query parameters

- `validation-level` integer

## Request body

- CreatePhoneInput: Field values of a new Phone record.
  - `modified` string, date-time: Last modification time.
  - `created` string, date-time: Creation time.
  - `error_code` integer: Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy.
  - `name` string, required: Name of the entity and its default text representation.
  - `owner_id` string, uuid: Id of the assigned user, or empty when the phone is a company-level resource.
  - `phone_number` string: Phone number in E.164 format (e.g. "+12025550123").
  - `twilio_caller_sid` string: External caller identifier from the calling provider (e.g. Twilio caller SID).
  - `type` 1 | 2 | 3 | 4 | 5 | 6, required: Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany
  - `revision` integer: Revision when entity was lastly changed.
  - `enabled` boolean, required: False when the user has disabled the calling/SMS integration on this phone (error_code is set to indicate user disablement); true otherwise.

## Response `201`

The created Phone record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Phone: Phone number connected to Coevera for calls, text messages or WhatsApp, either personal to a user or shared by the company.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `owner` string, uri: User the phone is assigned to, when the phone belongs to a specific user (personal calling/SMS line). Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields.
    - `error_code` integer: Error code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy.
    - `name` string, required: Name of the entity and its default text representation.
    - `owner_id` string, uuid: Id of the assigned user, or empty when the phone is a company-level resource.
    - `phone_number` string: Phone number in E.164 format (e.g. "+12025550123").
    - `twilio_caller_sid` string: External caller identifier from the calling provider (e.g. Twilio caller SID).
    - `type` 1 | 2 | 3 | 4 | 5 | 6, required: Channel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account. Integer enum value: 1 - Calling, 2 - CallingSmsUnassigned, 3 - CallingSmsPersonal, 4 - CallingSmsCompany, 5 - WhatsAppPersonal, 6 - WhatsAppCompany
    - `revision` integer: Revision when entity was lastly changed.
    - `message_forwarding_email` string: Email address that incoming text messages to this phone are forwarded to. Empty when forwarding is not configured.
    - `call_forwarding_phone` string: Phone number that incoming calls/SMS to this phone are forwarded to. Empty when forwarding is not configured.
    - `enabled` boolean, required: False when the user has disabled the calling/SMS integration on this phone (error_code is set to indicate user disablement); true otherwise.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)