Cancel a connection session

Revoke an unused linking session.

DELETE /v1/connection-sessions/{session_id}

Cancel a connection session

cURL

curl --request DELETE \
  --url https://api.swapnice.com/v1/connection-sessions/{session_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>'

200

{
  "id": "<string>",
  "app_id": "<string>",
  "customer_id": "<string>",
  "status": "created",
  "requested_purposes": [
    "account_linking"
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "consent_receipt_id": "<string>",
  "swapnice_user_id": "<string>"
}

Revoke an unused linking session.

Requires connections:write. Create a new session if the user needs to try again.

Authorizations

Authorization · string · header · required

OAuth 2.1 authorization code with PKCE. Implicit and password flows are unsupported.

Headers

Idempotency-Key · string · required

Required for mutating requests. Replays with the same key and payload hash return the original logical result; replays with a different payload hash return 409.

Required string length: 16 - 255

Path Parameters

session_id · string · required

Response

200

application/json

Session canceled or already terminal.

id · string · required

app_id · string · required

customer_id · string · required

status · enum<string> · required

Available options: created, authorized, completed, expired, revoked

requested_purposes · enum<string>[] · required

Available options: account_linking, personalization, analytics, support, event_enrichment, profile_resolution, measurement

expires_at · string<date-time> · required

created_at · string<date-time> · required

consent_receipt_id · string | null

swapnice_user_id · string | null