Migrate deleteCustomUserLink

This guide outlines the changes introduced in the Delete a custom user link v2 endpoint (previously known as deleteCustomUserLink in v1).

💡

Key changes

• Dual path identification: API v2 identifies the specific deletion target using two path parameters: userId and customUserLinkId. API v1 used mail and type as query parameters.

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/customuserlinks?mail=geralt%40rivia.pl&type=inbox%20link
• API v2: /api/v2/users/{userId}/custom-links/{customUserLinkId}

Input changes

This section details the specific alterations to the input requirements between API versions.

API v1 input example

curl --location -g --request DELETE 'https://{{host}}/api/v1/customuserlinks?company={{company}}&apiKey={{apiKey}}&mail=geralt%2540rivia.pl&type=inbox%2520link'

API v2 input example

curl --request DELETE \
     --url https://app.360learning.com/api/v2/users/507f1f77bcf86cd799439011/custom-links/507f1f77bcf86cd799439011 \
     --header '360-api-version: v2.0' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer access_token'

Main input differences

Output changes

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

API v1 output example

{
  "status": "custom_user_link_deleted"
}

API v2 output example

# Response: 204 No Content
# Body: Empty

Main output differences