v1

latestOpenAPI 3.0.32026-07-1416063.7 KB

Create Number

This endpoint creates a new number and associates it with the client.

post/numbers

Request body

namestring required

The name used to easily identify the number. Allowed values are between 2 and 255 characters.

statusstring required

The status of the number. Allowed values are active and inactive.

numberstring required

The number being requested for use. This number must come from the available search endpoint, and must still be available.

catchall_sequence_idinteger

The ID of the sequence used to handle catchall messages.

Response

201

Example response

{
  "data": {
    "name": "Test Number",
    "number": "+15555555555",
    "status": "active",
    "client_id": 1,
    "id": 1
  }
}