Cancel Card

post/api/cards/{cardId}/cancel-async

Cancel a card

Request

Path Parameters

cardIdstringrequired
ID of card

Response

Successful operation.

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.

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/cards/{cardId}/cancel-async' \
  --request POST \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/cards/{cardId}/cancel-async' \
  --request POST \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-secret>' \
  --header 'x-account-id: <target-account>'

curl 'https://test.immersve.com/api/cards/{cardId}/cancel-async' \
  --request POST \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-secret: <api-secret>' \
  --header 'x-account-id: <target-account>'

Example Response

No response body.

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