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

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

Create Brand

Used to create a new brand

  • POSTMethod
  • /v2/customers/customer/brands/handleURL
  • application/jsonContent-Type
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
Handle String The handle of the brand
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Request content fields
Name Type Required / Optional Description Restrictions
Hide optional terms Boolean Optional Indicates whether contact validations should hide optional terms if they fall under this brand.
Locale Enum Optional Locale to use for templates

Possible values:

  • en-US: English (US)
  • nl-NL: Dutch (NL)
  • ko-KR: Korean (KR)
  • tr-TR: Turkish (TR)
  • it-IT: Italian (IT)
  • fr-FR: French (FR)
  • uk-UA: Ukrainian (UA)
  • da-DK: Danish (DK)
  • es-ES: Spanish (ES)
  • pt-PT: Portuguese (PT)
  • de-DE: German (DE)
Organization String Required The name of the organization
  • Minimum length: 1
  • Maximum length: 255
Address lines List <String> Required The address lines
  • Minimum number of items: 1
  • Maximum number of items: 3
  • Minimum length: 1
  • Maximum length: 255
Postal code String Required Postal code
  • Minimum length: 1
  • Maximum length: 16
City String Required The city
  • Minimum length: 1
  • Maximum length: 255
State String Optional The state
  • Minimum length: 1
  • Maximum length: 255
Country code String Required The ISO 3166-1 alpha2 country code
  • Minimum length: 2
  • Maximum length: 2
Email String Required The email address
  • Regular expression: (?=.{1,64}@)[a-z0-9_\-+]+(?:\.[a-z0-9_\-+]+)*@(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 6
  • Maximum length: 255
URL String Optional The webiste address
  • Regular expression: http(s)?://([a-z0-9\-]+\.)+[a-z]{2,61}([/].*)?
  • Maximum length: 255
Voice String Required The voice telephone number
  • Minimum length: 6
  • Maximum length: 25
Fax String Optional The fax telephone number
  • Minimum length: 6
  • Maximum length: 25
Privacy contact String Optional The handle of the contact to use for domains with privacy protect. To be able to use this field you need special permission.
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Abuse contact String Optional The handle of the contact to be exposed publicly in the WHOIS/RDAP for abuse cases
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40

Successful request

Brand has been created successfully
  • 201 CreatedHTTP Status
Brand create has been requested successfully
  • 202 AcceptedHTTP Status

Failed requests

Generic errors can be expected.

URL fields
The handle of the customer
The handle of the brand
Request parameters
Indicates whether contact validations should hide optional terms if they fall under this brand.
Locale to use for templates
The name of the organization
The address lines
Postal code
The city
The state
The ISO 3166-1 alpha2 country code
The email address
The webiste address
The voice telephone number
The fax telephone number
The handle of the contact to use for domains with privacy protect. To be able to use this field you need special permission.
The handle of the contact to be exposed publicly in the WHOIS/RDAP for abuse cases
Request

POST /v2/customers/customer/brands/handle
Content-Type: application/json 

{}
Response