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

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

Used to create a contact

  • POSTMethod
  • /v2/customers/customer/contacts/handleURL
  • application/jsonContent-Type
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 contact handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Name Type Required / Optional Description Restrictions
brand String Optional The brand to link the contact to, defaults to the brand "default"
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
organization String Optional The name of the organization
  • Minimum length: 1
  • Maximum length: 255
name String Required The name of the person
  • Minimum length: 1
  • Maximum length: 255
addressLine List <String> Required The address lines
  • Minimum number of items: 1
  • Maximum number of items: 3
  • Minimum length: 1
  • Maximum length: 255
postalCode 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 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
voice String Required The voice telephone number. E164a format, eg: +31.384530759
  • Regular expression: \+[0-9]{1,3}\.[0-9]{1,14}
  • Minimum length: 4
  • Maximum length: 17
fax String Optional The fax telephone number. E164a format, eg: +31.384530759
  • Regular expression: \+[0-9]{1,3}\.[0-9]{1,14}
  • Minimum length: 4
  • Maximum length: 17

Successful request

  • 201 CreatedHTTP Status
  • application/jsonContent-Type

Failed requests

Generic errors can be expected.

The handle of the customer
The contact handle
The brand to link the contact to, defaults to the brand "default"
The name of the organization
The name of the person
The address lines
Postal code
The city
The state
The ISO 3166-1 alpha2 country code
The email address
The voice telephone number. E164a format, eg: +31.384530759
The fax telephone number. E164a format, eg: +31.384530759

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

{}