Need help? Call Live Support at +31 (0) 38 453 07 59

Used to preview a brand's template, preview is available for all templates except HEADER and FOOTER templates

  • GETMethod
  • /v2/customers/customer/brands/brand/templates/name/previewURL
Name Type Description Restrictions
customer String The handle of the customer
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
brand String The handle of the brand
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
name Enum The name of the template

Possible values:

  • UPDATE_DOMAIN_OLD_REGISTRANT
  • TMCH_CLAIM_ACK_FORM
  • INCOMING_TRANSFER_NEW_REGISTRANT_FORM
  • ERROR_PAGE
  • UPDATE_CONTACT_OLD_REGISTRANT_FORM
  • TMCH_CLAIM_ACK_AND_VALIDATION_FORM
  • INCOMING_FOA_FORM
  • UPDATE_DOMAIN_NEW_REGISTRANT
  • UPDATE_DOMAIN_TOKEN_FORM
  • ERRP_EXPIRED
  • ERRP_WEEK
  • UPDATE_CONTACT_OLD_REGISTRANT
  • INTERNAL_FOA_FORM
  • INTERNAL_TRANSFER_NEW_REGISTRANT_FORM
  • INCOMING_FOA
  • VALIDATE_CONTACT_FORM
  • THANK_YOU_PAGE
  • OUTGOING_TRANSFER_PRIVACY_PROTECT
  • VALIDATE_CONTACT
  • UPDATE_CONTACT_NEW_REGISTRANT
  • PENDING_VALIDATION
  • CONFIRM_BRAND_FORM
  • UPDATE_DOMAIN_NEW_REGISTRANT_FORM
  • INCOMING_TOKEN_FORM
  • UPDATE_CONTACT_NEW_REGISTRANT_FORM
  • WHOIS
  • ERRP_MONTH
  • CONFIRM_BRAND
  • INTERNAL_TOKEN_FORM
  • NEW_REGISTRANT_CHANGE_NOTIFICATION
  • OUTGOING_FOA_FORM
  • UPDATE_DOMAIN
  • INTERNAL_FOA
  • OUTGOING_FOA
  • TMCH_CLAIM_ACK
  • INTERNAL_TRANSFER_NEW_REGISTRANT
  • TMCH_CLAIM_ACK_AND_VALIDATION
  • WDRP
  • UPDATE_DOMAIN_OLD_REGISTRANT_FORM
  • OLD_REGISTRANT_CHANGE_NOTIFICATION
  • EXPIRED_PAGE
  • INCOMING_TRANSFER_NEW_REGISTRANT
Name Type Required / Optional Description Restrictions
context String Optional The context to request a preview for

Successful request

  • 200 OKHTTP Status
  • application/jsonContent-Type
Name Type Required / Optional Description
subject String Optional The subject, in case of a mail template
text String Optional The plain text template, in case of mail template
html String Optional The HTML template

Failed requests

Generic errors can be expected.

The handle of the customer
The handle of the brand
The name of the template
The context to request a preview for

GET /v2/customers/customer/brands/brand/templates/name/preview