Skip to main content
PUT
/
v1
/
contacts
/
{id}
/
phone-numbers
/
{phoneNumberId}
Update contact phone number
curl --request PUT \
  --url https://api.shingleai.com/v1/contacts/{id}/phone-numbers/{phoneNumberId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "+1 (555) 123-4567",
  "countryCode": "+1",
  "nationalNumber": "5551234567",
  "label": "Mobile",
  "data": {}
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phoneNumber": "<string>",
    "countryCode": "<string>",
    "nationalNumber": "<string>",
    "label": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "data": {}
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Path Parameters

id
string<uuid>
required

Contact UUID

phoneNumberId
string<uuid>
required

Phone Number UUID

Body

application/json
phoneNumber
string
Example:

"+1 (555) 123-4567"

countryCode
string | null
Example:

"+1"

nationalNumber
string | null
Example:

"5551234567"

label
string | null
Example:

"Mobile"

data
object

Response

Phone number updated successfully

data
object
required
meta
object