ZAzavudev

Update contact

Changed on
patch/v1/contacts/{contactId}

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/contacts/{contactId}
  • Auth
    HTTP bearer

Path parameters

contactIdstring required

Request body

displayNamestring nullable

Human-readable name for this contact. Set to null to clear it and fall back to the contact's identifier. Contacts created automatically from an inbound message have no display name until you set one.

defaultChannel'sms' | 'whatsapp' | 'telegram' | 'email' | 'instagram' | 'messenger' | 'voice' nullable

Preferred channel for this contact. Set to null to clear.

metadataobject

Example request

{
  "displayName": "John Doe"
}

Response

Contact updated.

idstring required
displayNamestring

Display name for the contact.

phoneNumberstring

DEPRECATED: Use primaryPhone instead. Primary phone number in E.164 format.

primaryPhonestring

Primary phone number in E.164 format.

primaryEmailstring email

Primary email address.

countryCodestring
profileNamestring nullable

Contact's WhatsApp profile name. Only available for WhatsApp contacts.

availableChannelsstring[] required

List of available messaging channels for this contact.

defaultChannel'sms' | 'whatsapp' | 'telegram' | 'email' | 'instagram' | 'messenger' | 'voice'

Preferred channel for this contact.

verifiedboolean required

Whether this contact has been verified.

metadataobject required
createdAtstring date-time required
updatedAtstring date-time

Example response

{
  "displayName": "John Doe",
  "phoneNumber": "+56912345678",
  "primaryPhone": "+56912345678",
  "primaryEmail": "john@example.com",
  "countryCode": "CL",
  "profileName": "John Doe",
  "whatsapp": {
    "bsuid": "CO.13491208655302741918"
  },
  "channels": [
    {
      "identifier": "+14155551234",
      "countryCode": "US",
      "label": "work"
    }
  ]
}

Changes

  • ce129d29ce3cRevision changes
    • info

      added the optional property to the response with the status

  • bae0dfda726aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property