<access-service>/api/v1/users/me/contacts/{contactId}

​

URL structure

https://access-service.xy-company.com/api/v1/users/me/contacts/{contactId}

​

Supported methods and overview

• PUT - modifies the an existing contact (specified by contactId) for a Covata user (whose access token is submitted in the request to this endpoint).
• DELETE - removes an existing contact (specified by contactId) or the Covata user (whose access token is submitted in the request to this endpoint).

​

Detailed description

• Modifies the email address, first name and/or last name of an existing contact (specified by contactId) that belongs to the Covata user (whose access token is submitted in the request to this endpoint).
  A contact’s ID is obtained via the GET method on the <access-service>/api/v1/users/me/contacts endpoint, which retrieves a list of information for all contacts of the Covata user (whose access token is submitted in the request).
  Note: A contact’s email address can be modified to one which does not match a registered Covata user account. However, if the Covata user successfully shares an item with this contact, then a new Covata user account is automatically created for this modified contact (with the Ad hoc role).
• Removes an existing contact (specified by contactId) that belongs to a Covata user (whose access token is submitted in the request to this endpoint).

​

Supported roles and conditions

• Originator and Collaborator - when the contact (specified by {contactId} in the request’s URL) belongs to this user.

​

Required headers

• Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

• Content-Type: application/json

​

Required PUT-request parameters

• email - The email address of the contact (specified by {contactId} in the URL and belonging to the Covata user whose access token is submitted in the request to this endpoint) to be modified.
  Example (PUT request):
  {
    "email": "christina.collaborator@xy-company.com"
  }
  

​

Optional PUT-request parameters

• firstName - The first name of the contact (specified by {contactId} in the URL and belonging to the Covata user whose access token is submitted in the request to this endpoint) to be modified. Omitting this value in the request clears this property’s value to null .
• lastName - The last name of this contact to be modified. Omitting this value in the request clears this property’s value to null .
  Example (PUT request with optional parameters):
  {
    "email": "christina.collaborator@xy-company.com",
    "firstName": "Christina",
    "lastName": "Collaborator"
  }
  

​

Returns

• id - The ID of the contact.
• email - The email address of the contact.
• firstName - The optional first name of the contact. If this value was not specified when the contact was created and/or last modified, then its value is null.
• lastName - The optional last name of the contact. If this value was not specified when the contact was created and/or last modified, then its value is also null.
• createdAt - The date and time when the contact was created.
• modifiedAt - The date and time when the contact was last modified.
  Example (response from a PUT request):
  {
      "id": "762179066710499328",
      "email": "christina.collaborator@xy-company.com",
      "firstName": "Christina",
      "lastName": "Collaborator",
      "modifiedAt": "2016-10-05T05:38:24.931Z",
      "createdAt": "2016-10-04T05:07:30.106Z"
  }