Contact

ch:contact LINK RELATION

Actions

method	description
GET	View contact
PATCH	Update contact
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required
name	string	true
email	email	true
phone	string	true
skype	string	false

Profile

A Contact represents the contact person for the given Application. In most cases this is the user responsible for creating and filling out the application.

The provided email will receive notifications during the application process.

The contact person should be added as a Collaborator. This way they can login to https://my.clearhaus.com and proceed with the application process. See ch:collaborators for more information on inviting collaborators.

If a signatory is provided in Application, they will become the point of contact from the moment a signature is requested for the Merchant Agreement. Subsequent notification emails will be sent to the signatory email.

Properties

name	type	read-only	commentable
name	string	false	true
email	email	false	true
phone	string	false	true
skype	string	false	true

Link relations

rel	conditional
self	false
ch:application	false
ch:comments	false

Additional semantics

Field comments

This resource supports field comments. See Field comments for more information.

Example representation

{
  "name": "Caroline S. Bech",
  "email": "CarolineSBech@example.com",
  "phone": "+45 41168678",
  "skype": "caroline.bech",
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/contacts/32f44d04-7662-48f3-a6d5-753740c0f757"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:comments": {
      "href": "https://merchant.test.clearhaus.com/contacts/32f44d04-7662-48f3-a6d5-753740c0f757/comments{?page,per_page}"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}