POST
/
api
/
portal
/
session
cURL
curl --request POST \
  --url http://sandbox.mintlify.com/api/portal/session \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "uniqueUserId": "titouan.launay@hotmail.com",
  "configuration": {
    "userDisplay": "Arthur",
    "returnUrl": "https://example.com"
  }
}'
{
  "sessionId": "<string>",
  "uniqueUserId": "<string>",
  "configuration": {
    "userDisplay": "<string>",
    "returnUrl": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Payload to create a new session

​
uniqueUserId
string
required

Unique identifier for the user

​
configuration
object
required

Response

Session created successfully

​
sessionId
string
required

The session identifier

​
uniqueUserId
string
required

Unique identifier for the user

​
configuration
object
required