Update person status

put

https://apim.demo01.my.fivedegrees.cloud/publicapi-sbx/api/v1/persons/{personId}/status

API endpoint to update status of a person.

Path Params

personId

uuid

required

Format - uuid. Identifier (GUID) of person.

Body Params

Update person status request

Model for updating person status

statusShortCode

string

required

length ≥ 1

New status shortcode of the person. In the reference data endpoint 'person-status' a user can get the full list of available values.

statusReasonShortCode

string | null

For some state transitions (to Blocked and to Former) a user need to specify a reason/extra information of the new state. For this a user can use put a status reason ShortCode. In the reference data API 'block-reasons' and 'offboarding-reasons' a user can get the full list of available values.

deceasedDate

date-time | null

Deceased date of the person.

Headers

x-request-id

uuid

required

Format - uuid. Correlates HTTP requests between a client and server

Responses

202

Accepted

500

Server Error

401Unauthorized

403Forbidden

404Not Found

422Client Error