POST
/
v1
/
offboarding
/
entities
curl --request POST \
  --url https://platform.realto.io/api/v1/offboarding/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "data": {
    "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "principalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requestType": "<string>",
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Body

The Offboarding Request

A request to offboard an Entity

​
entityId
string

The id of the Entity to offboard

Response

201
application/json
Created

An Offboarding Request

​
data
object

The data of an Offboarding Request

​
id
string

The id of the Offboarding Request

​
principalId
string

The id of the Principal that initiated the Offboarding Request

​
requestType
string | null

The type of the request.

​
status
string | null

The status of the Offboarding Request

Was this page helpful?

List all Entity Offboarding RequestsCancel an Entity Offboarding Request