Invites a member. Required scope: w_members. Accessible with all token types.
Result
Invites the member to Workable by sending them an email to the email address specified in the body of the request.
Making requests to the POST /members endpoint will create the given member and return it. It will also send an email to invite the member in the email specified in the request. An example of the response follows:
{
"id": "3ff4d641",
"email": "[email protected]",
"role": "simple",
"job_id": null,
"hris_role": "hris_admin",
"collaboration_rules": []
}
Each member will have the following keys:
| key | type | description |
|---|---|---|
| id | string | The member identifier |
string | The email address of the member | |
| role | string | The member's role. Possible values are admin, simple, reviewerand no_access |
| hris_role | string | The member's hris role. Possible values are hris_admin and hris_employee |
| job_id | string | The job which this member is invited to collaborate in |
| 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 |
If you try to create a member Workable API will response with 401 Unauthorized, 403 Forbidden and 422 Unprocessable Entity as error codes when an error occurs. Such errors can be mistakes in the authentication, trying to create a member with an email that already exists, mandatory fields missing, or make more invitations that your subscription plan allows.