API Documentation

Update person status

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

API endpoint to update status of a person.

Body Params

Update person status request

Model for updating person status

uuid
required

Identifier (GUID) of person.

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.

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.

Headers
uuid
required

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

Responses
202

Accepted

500

Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?