Delete a custom field: Migration guide

This guide details how the Delete a custom field endpoint has changed (previously known as deleteCustomField 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/customfields/:customFieldId
• API v2: /api/v2/custom-fields/{customFieldId}

Behavior changes

In API v1, custom fields applied only to users. API v2 introduces the concept of custom fields for path sessions in addition to users. This v2 endpoint can now delete custom fields associated with either users or path sessions, depending on the customFieldId provided.

Input changes

This endpoint has no specific input changes. The only adjustments needed are to adopt the new v2 authentication and versioning headers, which are detailed in the Authentication guide.

API v1 input example

Shell

curl --location -g --request DELETE 'https://app.360learning.com/api/v1/customfields/:customFieldId?company={{companyId}}&apiKey={{apiKey}}'

API v2 input example

Shell

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

Main input differences

Change type	API v1	API v2
Modified Path segment name	customfields	custom-fields

Output changes

While the core success response for deleting a custom field remains a 204 No Content, API v2 introduces more granular error codes to provide clearer feedback. See Delete a custom field for error details.