v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Task

Create Staff

Create a schedule staff. The staff is created as active by default. Use property_ids to limit the staff to specific properties; the staff will be created with access to all properties when omitted.

For international operators, mobile must be in +<country code> <number> format (e.g. +86 13800138000).

post/staffs

Request body

namestring required

Display name of the staff (max 128 characters).

mobilestring required

Mobile number. International operators must use +<country code> <number> format.

emailstring

Email address.

notestring

Free-form note (max 500 characters).

property_idsinteger[]

Properties this staff can access. Omit to grant access to all properties available to the operator.

Response

The staff has been successfully created.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}