Skip to main content

Verification Email Object

This section goes over the parts of the Verification Email object.

Verification Email Object Attributes

This is the JSON response that gets returned when a request is successful.

AttributeData TypeDescription
base_urlstringURL to be added to the email before verification token. If not specified, the default is used.
email_template_sidstringThe secure ID of the Email Template object on which this verification email is based.
partner_sidstringThe secure ID of the partner associated with the verification email.
status
read only
stringThe status of the verification. Values accepted in this field are:
  • created
  • sent_email
  • verified
to_addressstringThe email address to send the verification email.

Sample Verification Email Object

{
"base_url": "https://www.carrierx.com/confirmed",
"email_template_sid": "3e9e8c56-e1ee-4dcf-9e2b-abbd101139ba",
"partner_sid": null,
"status": "sent_email",
"to_address": "jsmith@carrierx.com"
}