REST Account Contact Option

List, get, create, update or delete contact options. A contact is equivalent to a person. An account contains company-related data. Multiple contacts can be assigned to an account. Assigning multiple contacts to an account is currently not available in the back end UI, but will be implemented in future versions. A contact may have multiple contact options, e.g. multiple phone numbers and multiple email addresses. A contact option is composed of the ID of the contact, the ID of the type, the ID of the sub-type and the actual value.

List contact options by the contact ID

Lists contact options. The ID of the contact must be specified.

/rest/accounts/contacts/{contactId}/options

Success 200

Field Type Description
id Int The ID of the contact option
contactId Int The ID of the contact the option belongs to
typeId Int The type ID of the contact option. It is possible to define individual contact option types. The following types are available by default and cannot be deleted:
  • 1 = Telephone
  • 2 = Email
  • 3 = Telefax
  • 4 = Web page
  • 5 = Marketplace
  • 6 = Identification number
  • 7 = Payment
  • 8 = User name
  • 9 = Group
  • 10 = Access
  • 11 = Additional
subTypeId Int The sub-type ID of the contact option. It is possible to define individual contact option sub-types. The following types are available by default and cannot be deleted:
  • 1 = Work
  • 2 = Mobile private
  • 3 = Mobile work
  • 4 = Private
  • 5 = PayPal
  • 6 = Ebay
  • 7 = Amazon
  • 8 = Klarna
  • 9 = DHL
  • 10 = Forum
  • 11 = Guest
  • 12 = Contact person
  • 13 = Marketplace partner
value String The value of the option. Depends on the type/sub-type.
priority Int The priority for sorting
createdAt String The time the option was created as unix timestamp
updatedAt String The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Validate a contact option by a given value

validates a contact option by a given value

/rest/accounts/contacts/{contactId}/options/validate

Success 200

Field Type Description
contentType String response content type
contentLength Int response content length
content String response content

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Create a contact option by the contact ID

Creates a contact option for an existing contact. The ID of the contact must be specified.

/rest/accounts/contacts/{contactId}/options

Success 200

Field Type Description
id Int The ID of the contact option
contactId Int The ID of the contact the option belongs to
typeId Int The type ID of the contact option. It is possible to define individual contact option types. The following types are available by default and cannot be deleted:
  • 1 = Telephone
  • 2 = Email
  • 3 = Telefax
  • 4 = Web page
  • 5 = Marketplace
  • 6 = Identification number
  • 7 = Payment
  • 8 = User name
  • 9 = Group
  • 10 = Access
  • 11 = Additional
subTypeId Int The sub-type ID of the contact option. It is possible to define individual contact option sub-types. The following types are available by default and cannot be deleted:
  • 1 = Work
  • 2 = Mobile private
  • 3 = Mobile work
  • 4 = Private
  • 5 = PayPal
  • 6 = Ebay
  • 7 = Amazon
  • 8 = Klarna
  • 9 = DHL
  • 10 = Forum
  • 11 = Guest
  • 12 = Contact person
  • 13 = Marketplace partner
value String The value of the option. Depends on the type/sub-type.
priority Int The priority for sorting
createdAt String The time the option was created as unix timestamp
updatedAt String The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a contact option by the contact ID

Updates a contact option for an existing contact. The ID of the contact must be specified.

/rest/accounts/contacts/{contactId}/options

Success 200

Field Type Description
id Int The ID of the contact option
contactId Int The ID of the contact the option belongs to
typeId Int The type ID of the contact option. It is possible to define individual contact option types. The following types are available by default and cannot be deleted:
  • 1 = Telephone
  • 2 = Email
  • 3 = Telefax
  • 4 = Web page
  • 5 = Marketplace
  • 6 = Identification number
  • 7 = Payment
  • 8 = User name
  • 9 = Group
  • 10 = Access
  • 11 = Additional
subTypeId Int The sub-type ID of the contact option. It is possible to define individual contact option sub-types. The following types are available by default and cannot be deleted:
  • 1 = Work
  • 2 = Mobile private
  • 3 = Mobile work
  • 4 = Private
  • 5 = PayPal
  • 6 = Ebay
  • 7 = Amazon
  • 8 = Klarna
  • 9 = DHL
  • 10 = Forum
  • 11 = Guest
  • 12 = Contact person
  • 13 = Marketplace partner
value String The value of the option. Depends on the type/sub-type.
priority Int The priority for sorting
createdAt String The time the option was created as unix timestamp
updatedAt String The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete a contact option by the contact ID

Deletes a contact option for an existing contact. The ID of the contact must be specified.

/rest/accounts/contacts/{contactId}/options

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Get a contact option by the option ID

Gets a contact option. The ID of the option must be specified.

/rest/accounts/contacts/options/{optionId}

Success 200

Field Type Description
id Int The ID of the contact option
contactId Int The ID of the contact the option belongs to
typeId Int The type ID of the contact option. It is possible to define individual contact option types. The following types are available by default and cannot be deleted:
  • 1 = Telephone
  • 2 = Email
  • 3 = Telefax
  • 4 = Web page
  • 5 = Marketplace
  • 6 = Identification number
  • 7 = Payment
  • 8 = User name
  • 9 = Group
  • 10 = Access
  • 11 = Additional
subTypeId Int The sub-type ID of the contact option. It is possible to define individual contact option sub-types. The following types are available by default and cannot be deleted:
  • 1 = Work
  • 2 = Mobile private
  • 3 = Mobile work
  • 4 = Private
  • 5 = PayPal
  • 6 = Ebay
  • 7 = Amazon
  • 8 = Klarna
  • 9 = DHL
  • 10 = Forum
  • 11 = Guest
  • 12 = Contact person
  • 13 = Marketplace partner
value String The value of the option. Depends on the type/sub-type.
priority Int The priority for sorting
createdAt String The time the option was created as unix timestamp
updatedAt String The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Update a contact option by the option ID

Updates a contact option. The ID of the option must be specified.

/rest/accounts/contacts/options/{optionId}

Success 200

Field Type Description
id Int The ID of the contact option
contactId Int The ID of the contact the option belongs to
typeId Int The type ID of the contact option. It is possible to define individual contact option types. The following types are available by default and cannot be deleted:
  • 1 = Telephone
  • 2 = Email
  • 3 = Telefax
  • 4 = Web page
  • 5 = Marketplace
  • 6 = Identification number
  • 7 = Payment
  • 8 = User name
  • 9 = Group
  • 10 = Access
  • 11 = Additional
subTypeId Int The sub-type ID of the contact option. It is possible to define individual contact option sub-types. The following types are available by default and cannot be deleted:
  • 1 = Work
  • 2 = Mobile private
  • 3 = Mobile work
  • 4 = Private
  • 5 = PayPal
  • 6 = Ebay
  • 7 = Amazon
  • 8 = Klarna
  • 9 = DHL
  • 10 = Forum
  • 11 = Guest
  • 12 = Contact person
  • 13 = Marketplace partner
value String The value of the option. Depends on the type/sub-type.
priority Int The priority for sorting
createdAt String The time the option was created as unix timestamp
updatedAt String The time the option was last updated as unix timestamp

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Delete a contact option by the option ID

Deletes a contact option. The ID of the option must be specified.

/rest/accounts/contacts/options/{optionId}

Success 200

This call does not have a response output.

Errors 4xx

Code Exception Description
401 League\OAuth2\Server\Exception\AccessDeniedException The resource owner or authorization server denied the request.
401 League\OAuth2\Server\Exception\InvalidRequestException The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. Check the "access token" parameter.

Is this article helpful?

 

Thank you for your Feedback

you can close this field now!