Show Developer Menu

POST /staff

Issuing a POST call to staff will allow you to create new staff user. Please keep in mind that this may have an impact on your monthly subscription cost.

Example Request with Email
curl 'https://{brand}.reamaze.io/api/v1/staff' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  -X POST -d '{"staff": {"name": "Jean Super Agent", "email": "jean@example.com", "password": "temporary password"}}'
Response

A successful request will return the JSON for the newly created staff.

A failed request will return an HTTP 422 Unprocessable Entity with the JSON body explaining the error.

Notes
  • The password attribute is optional. If it's not provided, a random secure password will be generated. The user can use the Reset Password function to set their password.
  • No invite emails are sent to the created user's email. This is to prevent potential abuse.
  • The created user will be asked to change their password the first time they log in.