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

Attention! You're currently using the OT&E environment.

Get Brand template

Used to retrieve a brand's template

  • GETMethod
  • /v2/customers/customer/brands/brand/templates/nameURL
URL fields
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:

  • EMAIL_HEADER
  • EMAIL_FOOTER
  • ERRP_WEEK
  • ERRP_MONTH
  • ERRP_EXPIRED
  • WEB_HEADER
  • WEB_FOOTER
  • INCOMING_FOA_FORM
  • INCOMING_FOA
  • INTERNAL_FOA_FORM
  • INTERNAL_FOA
  • INCOMING_TOKEN_FORM
  • INTERNAL_TOKEN_FORM
  • OUTGOING_FOA_FORM
  • OUTGOING_FOA
  • THANK_YOU_PAGE
  • ERROR_PAGE
  • PENDING_VALIDATION
  • VALIDATE_CONTACT_FORM
  • VALIDATE_CONTACT
  • WHOIS
  • WDRP
  • CONFIRM_BRAND
  • CONFIRM_BRAND_FORM
  • UPDATE_DOMAIN_TOKEN_FORM
  • TMCH_CLAIM_ACK
  • TMCH_CLAIM_ACK_AND_VALIDATION
  • TMCH_CLAIM_ACK_FORM
  • TMCH_CLAIM_ACK_AND_VALIDATION_FORM
  • EXPIRED_PAGE
  • UPDATE_DOMAIN_OLD_REGISTRANT
  • UPDATE_DOMAIN_OLD_REGISTRANT_FORM
  • UPDATE_DOMAIN_NEW_REGISTRANT
  • UPDATE_DOMAIN_NEW_REGISTRANT_FORM
  • UPDATE_CONTACT_OLD_REGISTRANT
  • UPDATE_CONTACT_OLD_REGISTRANT_FORM
  • UPDATE_CONTACT_NEW_REGISTRANT
  • UPDATE_CONTACT_NEW_REGISTRANT_FORM
  • INTERNAL_TRANSFER_NEW_REGISTRANT
  • INTERNAL_TRANSFER_NEW_REGISTRANT_FORM
  • INCOMING_TRANSFER_NEW_REGISTRANT
  • INCOMING_TRANSFER_NEW_REGISTRANT_FORM
  • OLD_REGISTRANT_CHANGE_NOTIFICATION
  • NEW_REGISTRANT_CHANGE_NOTIFICATION
  • UPDATE_DOMAIN
  • OUTGOING_TRANSFER_PRIVACY_PROTECT
Request parameters
Name Type Required / Optional Description Restrictions
fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

Brand template has been retrieved successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
name Enum Required The name of the template

Possible values:

  • EMAIL_HEADER:
  • EMAIL_FOOTER:
  • ERRP_WEEK:
  • ERRP_MONTH:
  • ERRP_EXPIRED:
  • WEB_HEADER:
  • WEB_FOOTER:
  • INCOMING_FOA_FORM:
  • INCOMING_FOA:
  • INTERNAL_FOA_FORM:
  • INTERNAL_FOA:
  • INCOMING_TOKEN_FORM:
  • INTERNAL_TOKEN_FORM:
  • OUTGOING_FOA_FORM:
  • OUTGOING_FOA:
  • THANK_YOU_PAGE:
  • ERROR_PAGE:
  • PENDING_VALIDATION:
  • VALIDATE_CONTACT_FORM:
  • VALIDATE_CONTACT:
  • WHOIS:
  • WDRP:
  • CONFIRM_BRAND:
  • CONFIRM_BRAND_FORM:
  • UPDATE_DOMAIN_TOKEN_FORM:
  • TMCH_CLAIM_ACK:
  • TMCH_CLAIM_ACK_AND_VALIDATION:
  • TMCH_CLAIM_ACK_FORM:
  • TMCH_CLAIM_ACK_AND_VALIDATION_FORM:
  • EXPIRED_PAGE:
  • UPDATE_DOMAIN_OLD_REGISTRANT:
  • UPDATE_DOMAIN_OLD_REGISTRANT_FORM:
  • UPDATE_DOMAIN_NEW_REGISTRANT:
  • UPDATE_DOMAIN_NEW_REGISTRANT_FORM:
  • UPDATE_CONTACT_OLD_REGISTRANT:
  • UPDATE_CONTACT_OLD_REGISTRANT_FORM:
  • UPDATE_CONTACT_NEW_REGISTRANT:
  • UPDATE_CONTACT_NEW_REGISTRANT_FORM:
  • INTERNAL_TRANSFER_NEW_REGISTRANT:
  • INTERNAL_TRANSFER_NEW_REGISTRANT_FORM:
  • INCOMING_TRANSFER_NEW_REGISTRANT:
  • INCOMING_TRANSFER_NEW_REGISTRANT_FORM:
  • OLD_REGISTRANT_CHANGE_NOTIFICATION:
  • NEW_REGISTRANT_CHANGE_NOTIFICATION:
  • UPDATE_DOMAIN:
  • OUTGOING_TRANSFER_PRIVACY_PROTECT:
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
contexts List <String> Required List of contexts in which this template can be used, "base" is de the default, other contexts specify specific registries with a different base template

Failed requests

Generic errors can be expected.

URL fields
The handle of the customer
The handle of the brand
The name of the template
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

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

Response