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

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

Update Brand

Used to update an existing brand. Only specified fields are updated, to remove an optional field specify it as an empty string ("")

  • POSTMethod
  • /v2/customers/customer/brands/handle/updateURL
  • 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
hideOptionalTerms Boolean Optional Indicates whether contact validations should hide optional terms if they fall under this brand.
locale String Optional Locale to use for templates
organization String Optional The name of the organization
  • Minimum length: 1
  • Maximum length: 255
addressLine List <String> Optional The address lines
  • Minimum number of items: 1
  • Maximum number of items: 3
  • Minimum length: 1
  • Maximum length: 255
postalCode String Optional Postal code
  • Minimum length: 1
  • Maximum length: 16
city String Optional The city
  • Minimum length: 1
  • Maximum length: 255
state String Optional The state, specify as empty string ("") to remove
  • Maximum length: 255
country String Optional The ISO 3166-1 alpha2 country code
  • Minimum length: 2
  • Maximum length: 2
email String Optional 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
contactUrl String Optional URL for the brand's contact page
  • Regular expression: http(s)?://([a-z0-9\-]+\.)+[a-z]{2,61}([/].*)?
  • Maximum length: 255
url String Optional The website address, specify as empty string ("") to remove
  • Regular expression: (|http(s)?://([a-z0-9\-]+\.)+[a-z]{2,63}([/].*)?)
  • Maximum length: 255
voice String Optional The voice telephone number
  • Minimum length: 6
  • Maximum length: 25
fax String Optional The fax telephone number, specify as empty string ("") to remove
  • Maximum length: 25
privacyContact 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\-_@\.]{3,40})
  • Maximum length: 40
abuseContact 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 updated successfully
  • 200 OKHTTP Status
Brand update 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

Specify as empty string: The state, specify as empty string ("") to remove
The ISO 3166-1 alpha2 country code
The email address

Specify as empty string: URL for the brand's contact page

Specify as empty string: The website address, specify as empty string ("") to remove
The voice telephone number

Specify as empty string: The fax telephone number, specify as empty string ("") to remove

Specify as empty string: 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/update
Content-Type: application/json 

{}
Response