Create Support Session

POST 
https://api.immersve.com/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

object[]

Array [

message string

path string

The location of the invalid path param, query param or payload attribute.

]

Example (from schema)

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

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"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.immersve.com/api/support-sessions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}'

Request Collapse all

Base URL

https://api.immersve.com

Auth

Security Scheme

Access TokenAccess Token and Target AccountApi Key and Api SecretApi Key and Api Secret and Target Account

Bearer Token

Body required

{
  "accountId": "65a7e8ef0d230d0a6bf755e07d39eb02"
}

ResponseClear

Click the Send API Request button above and see the response here!