Skip to main content
PATCH
/
api
/
contacts
/
{id}
/
verify-contact-methods
Set or clear verification on a contact's phone or email entry
curl --request PATCH \
  --url https://your-instance.example.com/api/contacts/{id}/verify-contact-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "phone",
  "value": "+14165550100",
  "verifiedAt": "2026-05-20T15:04:01.135Z",
  "verificationSource": "admin-manual"
}
'
{
  "message": "Phone number verified",
  "data": {
    "contact": {
      "_id": "64b2c3d4e5f60012345678aa",
      "firstName": "Alex",
      "lastName": "Morgan",
      "phoneNumber": [
        {
          "value": "+14165550100",
          "isPrimary": true,
          "verifiedAt": "2026-05-20T15:04:01.135Z",
          "verifiedBy": "64a1b2c3d4e5f60012345679",
          "verificationSource": "admin-manual"
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json

Toggle verification on a single phone or email entry. value must match an existing entry on the contact (phones are normalized to E.164; emails are lower-cased). Pass verifiedAt to mark verified; pass null (or omit) to clear.

​
type
enum<string>
required
Available options:
phone,
email
​
value
string
required

Phone (any format — normalized server-side) or email address.

​
verifiedAt
string<date-time> | null

ISO 8601 timestamp to set, or null to clear all verification fields on this entry.

​
verificationSource
string

Free-form label of where the verification came from (e.g. webchat, admin-manual). Only stored when verifiedAt is set.

Response

Verification metadata updated

Returned after a successful verify/unverify on a phone or email entry.

​
message
string
required

One of Phone number verified, Phone number verification cleared, Email verified, Email verification cleared.

​
data
object
required