Skip to main content
PATCH
/
v1
/
contacts
/
{contactId}
/
channels
/
{channelId}
Update channel
curl --request PATCH \
  --url https://api.zavu.dev/v1/contacts/{contactId}/channels/{channelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "verified": true,
  "metadata": {}
}
'
{
  "channel": {
    "id": "<string>",
    "identifier": "+14155551234",
    "isPrimary": true,
    "verified": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "countryCode": "US",
    "label": "work",
    "metrics": {
      "successCount": 123,
      "failureCount": 123,
      "totalAttempts": 123,
      "avgDeliveryTimeMs": 123,
      "lastSuccessAt": "2023-11-07T05:31:56Z"
    },
    "lastInboundAt": "2023-11-07T05:31:56Z",
    "metadata": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
contactId
string
required
​
channelId
string
required

Channel ID.

Body

application/json

Request body to update a channel.

​
label
string | null

Optional label for the channel. Set to null to clear.

Maximum string length: 50
​
verified
boolean

Whether the channel is verified.

​
metadata
object

Response

Channel updated.

​
channel
object
required

A communication channel for a contact.