Skip to content
Nairon Docs

/v1/projects/{projectId}/phone-numbers (POST)

POST
/v1/projects/{projectId}/phone-numbers
curl --request POST \
  --url https://service.v2.nairon.xyz/v1/projects/example/phone-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "number": "example", "status": "enabled", "type": "nairon", "flowId": "example", "externalPhoneFields": { "additionalProperty": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 200 characters
number
required
string
>= 1 characters <= 64 characters
status
string
default: disabled
Allowed values: enabled disabled
type
string
default: nairon
Allowed values: nairon partner external
flowId
Any of:
string format: cuid
/^[cC][0-9a-z]{6,}$/
externalPhoneFields
Any of:
object
key
additional properties

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
id
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
projectId
required
string format: cuid
/^[cC][0-9a-z]{6,}$/
type
required
string
Allowed values: nairon partner external
name
required
string
number
required
string
status
required
string
Allowed values: enabled disabled
flowId
required
Any of:
string format: cuid
/^[cC][0-9a-z]{6,}$/
externalPhoneFields
required
Any of:
createdAt
required
string
updatedAt
required
string
Example
{
  "type": "nairon",
  "status": "enabled"
}