API Reference

/members

Updates a member. Required scope: w_members. Accessible with all token types.

Result

If a member is already in the process of being updated then a 422 Unprocessable Entity error is expected.

Calling the PUT /members endpoint will update the given member and return it. An example of the response follows:

{
  "id": "3ff4d641",
  "name": "John Doe",
  "headline": "headline",
  "email": "[email protected]",
  "role": "simple",
  "hris_role": "hris_admin",
  "collaboration_rules":[]
}

Each member will have the following keys:

keytypedescription
idstringThe member identifier
namestringThe full name of the member
headlinestringThe headline of the member
emailstringThe email address of the member
rolestringThe member's role. Possible values are admin, simple, reviewerand no_access
hris_rolestringThe member's hris role. Possible values are hris_admin and hris_employee
collaboration_rulesArray An array of the collaboration rules the member has. Each rule contains the role of the member in the collaboration, an array of departments and an array of locations that this collaborations is applicable for. More info here
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!