Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Courses

Replace all custom field values for a course

🔑

Required OAuth scope: courses:write.

Replaces all custom field values in the given course with the provided ones. Values not included are removed.

put/api/v2/courses/{courseId}/custom-fields/values

Path parameters

courseIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the course.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

Example request

{
  "customValues": [
    {
      "customFieldId": "507f1f77bcf86cd799439011",
      "value": "US"
    }
  ]
}

Response

Returns the updated course custom field values.

customFieldIdstring ObjectId required

The unique ID of the custom field.

type'string' | 'date' required

The type of the custom field.

Example response

[
  {
    "customFieldId": "507f1f77bcf86cd799439011",
    "value": "US"
  }
]