Create Support Session

post/api/support-sessions

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

Request

Body application/json

accountIdstringrequired
The ID of the cardholder account that needs support

Response

Successful operation.

Body application/json

urlstringrequired
The URL of the support session

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

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

FORBIDDEN Insufficient permissions to perform the action.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://api.immersve.com/api/support-sessions \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

curl https://api.immersve.com/api/support-sessions \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

curl https://api.immersve.com/api/support-sessions \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

curl https://api.immersve.com/api/support-sessions \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

curl https://test.immersve.com/api/support-sessions \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

curl https://test.immersve.com/api/support-sessions \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

curl https://test.immersve.com/api/support-sessions \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

curl https://test.immersve.com/api/support-sessions \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

Example Response

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

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

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