Mark a phone number as verified

put

Mark a customer's phone number as verified or unverified. Only one phone number can be verified at a time per agent.

Authorizations
AuthorizationstringRequired

Bearer {apikey}

Path parameters
agentIdstringRequired

The agent ID

customerIdstringRequired

The customer ID

phoneNumberIdstringRequired

The phone number ID

Body
valuebooleanRequired

Whether to mark the phone number as verified (true) or unverified (false)

replacePolicystring · enumOptional

How to handle existing verified numbers: 'reject' to throw error if another number is verified, 'override' to unverify existing verified number

Possible values:
Responses
200

Phone number verification status updated successfully

application/json
put
/v1/agents/{agentId}/customers/{customerId}/phone-numbers/{phoneNumberId}/verify

Last updated