Skip to main content
PATCH
/
api
/
phone_numbers
/
{id}
PATCH /api/phone_numbers/{id}
curl --request PATCH \
  --url https://api.sippet.ai/api/phone_numbers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "id": "<string>",
    "attributes": {
      "label": "<string>",
      "phone_e164": "<string>"
    },
    "relationships": {},
    "type": "PhoneNumber"
  }
}
'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "phone_e164": "<string>",
      "label": "<string>"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "<string>",
          "type": "<string>",
          "meta": {}
        }
      }
    }
  },
  "included": [
    "<unknown>"
  ],
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://sippet.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT for bearer authentication

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Relationship paths to include in the response

Pattern: ^()(,())*$
​
fields
object

Limits the response fields to only those listed for each type

Example:
{ "PhoneNumber": "id,phone_e164,label" }

Body

application/vnd.api+json

Request body for the /phone_numbers/:id operation on PhoneNumber resource

​
data
object
required

Response

Success

​
data
object

A "Resource object" representing a PhoneNumber

​
included
any[]
​
meta
object