Create a support session

POST 
/api/support-sessions

This endpoint can be used to create a support session for a cardholder account

Request

application/json

Body

required

accountId stringrequired

The ID of the cardholder account that needs support

Responses

200

Successful operation

application/json

Schema

Schema

url stringrequired

The URL of the support session

Example (from schema)

{
  "url": "https://help.immersve.com/"
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
errors string[]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "BAD_REQUEST",
  "errors": [
    "Expected string, received number"
  ]
}

403

User is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN Insufficient permissions to perform the action.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...