Delete a path session: Migration guide

This guide details how the Delete a path session endpoint has changed (previously known as deletePathSession in v1).

Documentation links

Here are the links to the API reference for:

• API v1
• API v2

Endpoint mapping

Here's the direct correlation between the v1 and v2 endpoint URLs:

• API v1: /api/v1/paths/sessions/:session_id
• API v2: /api/v2/paths/{pathId}/sessions/{sessionId}

Input changes

The v2 endpoint also requires the pathId in the URL, in addition to the sessionId.

API v1 input example

Shell

curl --location -g --request DELETE 'https://app.360learning.com/api/v1/paths/sessions/667b608a1a92bb4fb526b31a?company={{company}}&apiKey={{apiKey}}'

API v2 input example

Shell

curl --request DELETE \
  --url https://app.360learning.com/api/v2/paths/507f1f77bcf86cd799439011/sessions/667b608a1a92bb4fb526b31a \
  --header '360-api-version: v2.0' \
  --header 'authorization: Bearer access_token'

Main input differences

Change type	API v1	API v2
Added Path parameter	-	pathId (Required): The unique ID of the path.

Output changes

This section details the specific alterations to the successful output returned between API versions.

API v1 output example

JSON

{
  "status": "path_session_deleted"
}

API v2 output example

JSON

// HTTP Status Code: 204 No Content
// The response body is empty.

Main output differences

API v2 now returns a 204 No Content status with an empty body for a successful deletion. This contrasts with API v1, which returned a 200 OK status with a JSON object confirming the deletion.

Change type	API v1	API v2
Removed Output property	status (Required): Indicates the status of the session deletion (e.g., "path_session_deleted"). Removed from endpoint v2 version, not replaced.	-
Modified Success output	200 OK with a JSON response body.	204 No Content with an empty response body.