Skip to main content

Get Email Template by SID

This request returns data for an email template, targeted by secure ID.

get /verification/email/templates/{template_sid}

Sample

A sample GET request to get email templates matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/verification/email/templates/465eb46b-05a7-4251-b89c-e99f2b81509b?exclude_fields=html_body' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a serialized copy of the Email Template object:

{
"bcc_addresses": "jsmith@freeconferencecall.com",
"cc_addresses": null,
"from_address": "noreply@carrierx.com",
"name": "Forgot Partner Password template",
"subject": "QA: CarrierX Password Reset",
"template_sid": "465eb46b-05a7-4251-b89c-e99f2b81509b",
"text_body": "To complete your password reset, please click the link below:\n${base_url}?token=${uuid}\n\nYou are receiving this email because someone has initiated a password reset on\nyour account.\n\n4300 E. Pacific Coast Highway | Long Beach, CA | 90804\n",
"to_addresses": null,
"type": "forgot_partner_password"
}

This request is enabled for Field Filtering.

Required Scopes

To get information about an Email Template object, the partner must have one of the following scopes enabled:

  • verification.manage
  • verification.read

Path Arguments

ParameterData TypeDescription
template_sid requiredstringThe template secure ID.