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"
}
'

import requests

url = "https://your-instance.example.com/api/contacts/{id}/verify-contact-methods"

payload = {
    "type": "phone",
    "value": "+14165550100",
    "verifiedAt": "2026-05-20T15:04:01.135Z",
    "verificationSource": "admin-manual"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'phone',
    value: '+14165550100',
    verifiedAt: '2026-05-20T15:04:01.135Z',
    verificationSource: 'admin-manual'
  })
};

fetch('https://your-instance.example.com/api/contacts/{id}/verify-contact-methods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-instance.example.com/api/contacts/{id}/verify-contact-methods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'phone',
    'value' => '+14165550100',
    'verifiedAt' => '2026-05-20T15:04:01.135Z',
    'verificationSource' => 'admin-manual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.example.com/api/contacts/{id}/verify-contact-methods"

	payload := strings.NewReader("{\n  \"type\": \"phone\",\n  \"value\": \"+14165550100\",\n  \"verifiedAt\": \"2026-05-20T15:04:01.135Z\",\n  \"verificationSource\": \"admin-manual\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://your-instance.example.com/api/contacts/{id}/verify-contact-methods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"phone\",\n  \"value\": \"+14165550100\",\n  \"verifiedAt\": \"2026-05-20T15:04:01.135Z\",\n  \"verificationSource\": \"admin-manual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-instance.example.com/api/contacts/{id}/verify-contact-methods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"phone\",\n  \"value\": \"+14165550100\",\n  \"verifiedAt\": \"2026-05-20T15:04:01.135Z\",\n  \"verificationSource\": \"admin-manual\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
        }
      ]
    }
  }
}

{
  "error": "Attachment not found",
  "message": "Attachment not found"
}

{
  "error": "Attachment not found",
  "message": "Attachment not found"
}

{
  "error": "Attachment not found",
  "message": "Attachment not found"
}

Contacts

Set or clear verification on a contact's phone or email entry

Toggles verification metadata on a single entry in a contact’s phoneNumber[] or email[] array. Pass verifiedAt as an ISO timestamp to mark the entry verified (also stamps verifiedBy from the caller and the supplied verificationSource); pass verifiedAt: null (or omit it) to clear all three. Phone values are normalized via the same E.164 helper the rest of the API uses; email values are lower-cased. Scoped to the caller’s organization unless SUPERADMIN. Emits a contact_updated socket event and writes a manual-event audit entry (CONTACT_METHOD_VERIFIED / CONTACT_METHOD_UNVERIFIED).

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"
}
'

import requests

url = "https://your-instance.example.com/api/contacts/{id}/verify-contact-methods"

payload = {
    "type": "phone",
    "value": "+14165550100",
    "verifiedAt": "2026-05-20T15:04:01.135Z",
    "verificationSource": "admin-manual"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'phone',
    value: '+14165550100',
    verifiedAt: '2026-05-20T15:04:01.135Z',
    verificationSource: 'admin-manual'
  })
};

fetch('https://your-instance.example.com/api/contacts/{id}/verify-contact-methods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-instance.example.com/api/contacts/{id}/verify-contact-methods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'phone',
    'value' => '+14165550100',
    'verifiedAt' => '2026-05-20T15:04:01.135Z',
    'verificationSource' => 'admin-manual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.example.com/api/contacts/{id}/verify-contact-methods"

	payload := strings.NewReader("{\n  \"type\": \"phone\",\n  \"value\": \"+14165550100\",\n  \"verifiedAt\": \"2026-05-20T15:04:01.135Z\",\n  \"verificationSource\": \"admin-manual\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://your-instance.example.com/api/contacts/{id}/verify-contact-methods")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"phone\",\n  \"value\": \"+14165550100\",\n  \"verifiedAt\": \"2026-05-20T15:04:01.135Z\",\n  \"verificationSource\": \"admin-manual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-instance.example.com/api/contacts/{id}/verify-contact-methods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"phone\",\n  \"value\": \"+14165550100\",\n  \"verifiedAt\": \"2026-05-20T15:04:01.135Z\",\n  \"verificationSource\": \"admin-manual\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
        }
      ]
    }
  }
}

{
  "error": "Attachment not found",
  "message": "Attachment not found"
}

{
  "error": "Attachment not found",
  "message": "Attachment not found"
}

{
  "error": "Attachment not found",
  "message": "Attachment not found"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

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

Show child attributes

⌘I

Overview

Endpoints

Set or clear verification on a contact's phone or email entry

Authorizations

Path Parameters

Body

Response