POST
/
v1
/
guided-onboarding-sessions
curl --request POST \
  --url https://platform.realto.io/api/v1/guided-onboarding-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "companyName": "<string>",
  "collectiveId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "manufacturer": "<string>",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vin": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>"
}

Authorizations

Authorization
string
header
required

Access Token Authentication

Body

The Guided Onboarding Session request

The request to onboard an Entity through guided onboarding UI

companyName
string | null

The company name displayed on the UI of the guided onboarding

collectiveId
string | null

The id of the Collective the Entity will be added to

manufacturer
string | null

The manufacturer of the Entity that will be onboarded

tenantId
string | null

The id of the Tenant the Entity will be added to

vin
string | null

The VIN of the Entity that will be onboarded

Response

201
application/json
Created

The output after creating a guided onboarding session

id
string
required

The id of the created guided onboarding session

url
string | null
required

The url to be used for starting the guided onboarding session