put https://{subdomain}.workable.com/spi/v3/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.
It is also important to note that when updating a new member, the following role inputs are not allowed and will result in a 422 Unprocessable Entity
error:
- Role
no_access
- if HRIS application is deactivated - Role
no_access
, HRIS rolehris_no_access
- if HRIS application is activated - Role different than
admin
when the member is the last admin of the account - Role different than
hris_admin
when the member is the last HRIS admin of the account - Role combination different than
admin
andhris_admin
- if HRIS application is activated and member is the only one who is an admin and also an HRIS admin
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": "john.doe@workable.com",
"role": "simple",
"hris_role": "hris_admin",
"collaboration_rules":[]
}
Each member
will have the following keys:
key | type | description |
---|---|---|
id | string | The member identifier |
name | string | The full name of the member |
headline | string | The headline of the member |
string | The email address of the member | |
role | string | The member's role. Possible values are admin , simple , reviewer and no_access |
hris_role | string | The member's hris role. Possible values are hris_admin , hris_employee and hris_no_access |
collaboration_rules | Array | 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 |