API Documentation

Update company status

put
https://apim.demo01.my.fivedegrees.cloud/publicapi-sbx/api/v1/companies//status

API endpoint to update the status of a company.

Path Params
uuid
required

Format - uuid. Identifier (GUID) of company.

Body Params

Update company status request

Model for updating company status

string
required
length ≥ 1

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

string | null

For some state transitions (to Blocked and to Former) a user needs 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 endpoint '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?