Skip to main content
POST
/
clients
/
me
/
eject
Mark client as ejected
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/eject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientPlatform": "<string>",
  "clientPlatformVersion": "<string>"
}
'
{
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json
​
clientPlatform
string

The client platform identifier.

​
clientPlatformVersion
string

The client platform version.

Response

Client ejected successfully