Update Verification Request
PATCH/messaging_tollfree/verification/requests/:id
Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.
Request
Path Parameters
- application/json
Body
required
Array [
]
Array [
]
Possible values: <= 500 characters
Name of the business; there are no specific formatting requirements
Possible values: <= 500 characters
A URL, including the scheme, pointing to the corporate website
Possible values: <= 500 characters
Line 1 of the business address
Possible values: <= 500 characters
Line 2 of the business address
Possible values: <= 500 characters
The city of the business address; the first letter should be capitalized
Possible values: <= 500 characters
The full name of the state (not the 2 letter code) of the business address; the first letter should be capitalized
Possible values: <= 500 characters
The ZIP code of the business address
Possible values: <= 500 characters
First name of the business contact; there are no specific requirements on formatting
Possible values: <= 500 characters
Last name of the business contact; there are no specific requirements on formatting
Possible values: <= 500 characters
The email address of the business contact
Possible values: <= 500 characters
The phone number of the business contact in E.164 format
Possible values: [10, 100, 1,000, 10,000, 100,000, 250,000, 500,000, 750,000, 1,000,000, 5,000,000, 10,000,000+]
Message Volume Enums
phoneNumbers
object[]
required
Possible values: >= 1
The phone numbers to request the verification of
Possible values: [2FA, App Notifications, Appointments, Auctions, Auto Repair Services, Bank Transfers, Billing, Booking Confirmations, Business Updates, COVID-19 Alerts, Career Training, Chatbot, Conversational / Alerts, Courier Services & Deliveries, Emergency Alerts, Events & Planning, Financial Services, Fraud Alerts, Fundraising, General Marketing, General School Updates, HR / Staffing, Healthcare Alerts, Housing Community Updates, Insurance Services, Job Dispatch, Legal Services, Mixed, Motivational Reminders, Notary Notifications, Order Notifications, Political, Public Works, Real Estate Services, Religious Services, Repair and Diagnostics Alerts, Rewards Program, Surveys, System Alerts, Voting Reminders, Waitlist Alerts, Webinar Reminders, Workshop Alerts]
Tollfree usecase categories
Possible values: <= 500 characters
Human-readable summary of the desired use-case
Possible values: <= 1000 characters
An example of a message that will be sent from the given phone numbers
Possible values: <= 500 characters
Human-readable description of how end users will opt into receiving messages from the given phone numbers
optInWorkflowImageURLs
object[]
required
Possible values: >= 1
Images showing the opt-in workflow
Possible values: non-empty and <= 2083 characters
Possible values: <= 500 characters
Any additional information
Possible values: <= 500 characters
ISV name
Possible values: <= 500 characters
URL that should receive webhooks relating to this verification request
Responses
200: Successful Response
- application/json
default: Unexpected error
- application/json
Request samples
curl -L -X PATCH 'https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"businessName": "Telnyx LLC",
"corporateWebsite": "http://example.com",
"businessAddr1": "311 W Superior St",
"businessAddr2": "121 W Superior St",
"businessCity": "Chicago",
"businessState": "Illinois",
"businessZip": "60654",
"businessContactFirstName": "John",
"businessContactLastName": "Doe",
"businessContactEmail": "email@example.com",
"businessContactPhone": "+18005550100",
"messageVolume": "10",
"phoneNumbers": [
{
"phoneNumber": "+18773554398"
},
{
"phoneNumber": "+18773554399"
}
],
"useCase": "2FA",
"useCaseSummary": "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal",
"productionMessageContent": "Your Telnyx OTP is XXXX",
"optInWorkflow": "User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they'\''ve opted in a confirmation message is sent out to the handset",
"optInWorkflowImageURLs": [
{
"url": "https://telnyx.com/sign-up"
},
{
"url": "https://telnyx.com/company/data-privacy"
}
],
"additionalInformation": "string",
"isvReseller": "string",
"webhookUrl": "http://example-webhook.com"
}'
Response samples
{
"businessName": "Telnyx LLC",
"corporateWebsite": "http://example.com",
"businessAddr1": "311 W Superior St",
"businessAddr2": "121 W Superior St",
"businessCity": "Chicago",
"businessState": "Illinois",
"businessZip": "60654",
"businessContactFirstName": "John",
"businessContactLastName": "Doe",
"businessContactEmail": "email@example.com",
"businessContactPhone": "+18005550100",
"messageVolume": "10",
"phoneNumbers": [
{
"phoneNumber": "+18773554398"
},
{
"phoneNumber": "+18773554399"
}
],
"useCase": "2FA",
"useCaseSummary": "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal",
"productionMessageContent": "Your Telnyx OTP is XXXX",
"optInWorkflow": "User signs into the Telnyx portal, enters number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
"optInWorkflowImageURLs": [
{
"url": "https://telnyx.com/sign-up"
},
{
"url": "https://telnyx.com/company/data-privacy"
}
],
"additionalInformation": "This is for security purposes, blah blah blah",
"isvReseller": "Yes",
"webhookUrl": "http://example-webhook.com",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"verificationRequestId": "string",
"verificationStatus": "Verified"
}
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}