36360learning
Custom Fields

Create a custom field

Changed on

🔑

Required OAuth scope: customFields:write.

Creates a custom field.

post/api/v2/custom-fields

Request

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

Headers

360-api-version'v2.0' required

The version of the API.

Request body

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.

Example request

{
  "name": "Department"
}

Response

Returns the created 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

  • d827a4a84180Revision changes
    • info

      removed subschema #4: Custom Fields Target Type Not Enabled from the response body oneOf list for the response status