v1

latestOpenAPI 3.0.02026-07-26866217.8 KB

Task

Update Staff

Update an existing staff. All fields are optional; only the supplied fields are changed. Passing property_ids replaces the staff's full property assignment list (use an empty array to clear). Use is_active to enable or disable the staff.

patch/staffs/{id}

Path parameters

idinteger required

Id of the staff to update.

Request body

namestring

mobilestring

emailstring

notestring

is_activeboolean

Enable (true) or disable (false) the staff.

property_idsinteger[]

Replaces the staff's property assignment list. Use an empty array to remove all assignments.

Response

The staff has been successfully updated.

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."
}