36360learning
Custom Fields

Edit a custom field

🔑

Required OAuth scope: customFields:write.

Edits specific fields of an existing custom field. Fields not included in the request payload remain unchanged.

patch/api/v2/custom-fields/{customFieldId}

Request

  • Base URL
    https://app.360learning.com
  • URL
    https://app.360learning.com/api/v2/custom-fields/{customFieldId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /api/v2/oauth2/token

Path parameters

customFieldIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the custom field.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

namestring required

The name of the custom field.

Example request

{
  "name": "Department"
}

Response

Returns the updated custom field.

namestring required

The name of the custom field.

targetType'users' | 'contents' required

The resource type to which the custom field is linked.

type'string' | 'date' required

The type of the custom field. Options are:

  • string: the field holds a text value.
  • date: the field holds an ISO 8601 date value.
_idstring ObjectId required

The unique ID of the custom field.

Example response

{
  "name": "Department",
  "_id": "507f1f77bcf86cd799439011"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.