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:
- ERRP_WEEK
- ERRP_MONTH
- ERRP_EXPIRED
- 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
|
Name |
Type |
Required / Optional |
Description |
Restrictions |
context |
String
|
Optional |
The context to request a preview for
|
|
Successful request
Brand template preview has been retrieved successfully
- 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.
GET
/v2/customers/customer/brands/brand/templates/name/preview
The tryout functionality for our API is only available for authenticated users. If you do not yet have an account, our support team can create it for you.
Email Support
Login