Update a content

Updated:

PUT/lms/{connection_id}/content/{id}

Updates the LmsContent identified by id. Provide the unified LmsContent fields to change in the request body.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Content

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
external_referencestring
course_idsstring array
namestring
descriptionstring
languagesstring array
media array
is_activeboolean
duration_minutesnumber
categoriesstring array
subjects array
Topic taxonomy as {name, rank} pairs carrying the full ancestor chain (rank = depth, 0 = top level)
skillsstring array
tagsstring array
difficultystring
Difficulty or level of the content (e.g. Beginner, Intermediate, Advanced)
sort_ordernumber
provider_namestring
short_descriptionstring
localizations array
collection_idsstring array
(reference to CommerceCollection)
instructors array
published_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
external_referencestringNo
course_idsstring[]No
namestringNo
descriptionstringNo
languagesstring[]No
mediaLmsMedia[]No
media[].urlstringNo
media[].namestringNo
media[].descriptionstringNo
media[].typeenumNoValues: IMAGE, HEADSHOT, VIDEO, WEB, DOCUMENT, TEXT, HTML, OTHER
media[].thumbnail_urlstringNo
media[].contentstringNoInline text/HTML/markdown content (use when url is empty or for embedded content)
media[].languagesstring[]NoISO 2-digit language codes
is_activebooleanNo
duration_minutesnumberNo
categoriesstring[]No
subjectsLmsSubject[]NoTopic taxonomy as {name, rank} pairs carrying the full ancestor chain (rank = depth, 0 = top level)
subjects[].namestringNo
subjects[].ranknumberNoDepth of this subject in the provider's topic hierarchy (0 = top level)
skillsstring[]No
tagsstring[]No
difficultystringNoDifficulty or level of the content (e.g. Beginner, Intermediate, Advanced)
sort_ordernumberNo
provider_namestringNo
short_descriptionstringNo
localizationsLmsContentLocalization[]No
localizations[].namestringNo
localizations[].descriptionstringNo
localizations[].languagestringNo
collection_idsstring[]No(reference to CommerceCollection)
instructorsLmsReference[]No
instructors[].idstringNo
instructors[].namestringNo
published_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataLmsMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'PUT',
  url: 'https://api.unified.to/lms/5de520f96e439b002043d8dc/content/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?