Skip to content
Nairon Docs

/v1/phone-numbers/{phoneNumberId}/flow

PATCH
/v1/phone-numbers/{phoneNumberId}/flow
curl --request PATCH \
  --url https://service.v2.nairon.xyz/v1/phone-numbers/example/flow \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "flowId": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
flowId
required
Any of:
string format: cuid
/^[cC][0-9a-z]{6,}$/
Examplegenerated
{
  "flowId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

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"
}