Invites a new or existing user to a role
Code | Description |
---|---|
400 | Bad Request: body has wrong syntax or unable to handle request |
401 | Unauthorized: auth_token omitted or authentication failed |
403 | Forbidden: This action cannot be performed |
404 | Not Found: The requested resource could not be found |
406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
409 | Conflict: Conflict with the current state of the resource |
422 | Unprocessable Entity: body has wrong attributes |
REQUEST Content-Type: application/json { "email": "good.employee@company.com", "reply_to_email": "admin@company.com" } RESPONSE 201 (Created) { "id": 782942, "email": "good.employee@company.com" }
Param name | Description |
---|---|
auth_token optional |
API token needed to authorize requests Validations:
|
email required |
The email address of the user to invite to the specified role Validations:
|
reply_to_email optional |
The email address used in the reply to field of the invitation email Validations:
|