Delete a custom link: Migration guide

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

💡

Key changes

• ID-based deletion: In v1, you deleted links using a descriptive type string. In v2, you must use the unique customLinkId (the _id returned when the link was created). If you do not have the ID stored, you can find it by listing your links via List custom links.
• Path parameters: The identifier has moved from a query string (?type=...) directly into the URL path (/custom-links/{customLinkId}).
• Empty success response: To align with REST standards, a successful deletion now returns a 204 No Content status. This means there is no longer a JSON body to parse; the HTTP status code itself confirms the deletion.

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/customlinks
• API v2: /api/v2/custom-links/{customLinkId}

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://app.360learning.com/api/v1/customlinks?company={{company}}&apiKey={{apiKey}}&type=inbox%2520link'

API v2 input example

curl --request DELETE \
     --url https://app.360learning.com/api/v2/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_link_deleted"
}

API v2 output example

// API v2 returns a 204 No Content success status (or empty body) for successful deletions.

Main output differences

API v2 removes the status string in favor of standard HTTP status codes.