Skip to main content
PATCH
Update a learning item

Authorizations

Authorization
string
header
required

An API key issued by a company administrator — an environment prefix (production: sdb_live_) followed by 32 characters. The prefix identifies the environment and MUST NOT be hard-coded or validated by clients; treat the whole key as opaque. Shown exactly once at creation; only a one-way hash is stored.

Scopes (granted per key on the create screen; :write never implies :read):

  • skills:read
  • skills:write
  • people:read
  • people:write
  • careers:read
  • careers:write
  • training:read
  • training:write
  • flags:read
  • flags:write
  • org:read
  • org:write
  • assessments:read
  • learning:read
  • learning:write
  • certifications:read
  • certifications:write
  • assessments:write
  • proficiency:read
  • proficiency:write
  • surveys:read
  • surveys:write
  • labels:read
  • labels:write

Headers

Idempotency-Key
string

Any unique string (at most 200 characters). Retrying with the same key and identical content replays the stored response for 24h instead of executing twice.

Maximum string length: 200

Path Parameters

id
string
required

Opaque resource id.

Body

application/json
description
string | null
Maximum string length: 4000
Example:

"Annual refresher for licensed operators."

url
string | null
Maximum string length: 500
Example:

"https://learn.example.com/forklift"

durationHours
number | null
Example:

2.5

cost
number | null
Example:

120

costDescription
string | null
Maximum string length: 500
Example:

"Per seat"

providerId
string | null

Training provider id (reference list).

Example:

"3"

formatId
string | null

Training format id (reference list).

Example:

"2"

audienceId
string | null

Training audience id (reference list).

Example:

"1"

courseLevelId
string | null

Training course level id (reference list).

Example:

"4"

referenceId
string | null
Maximum string length: 100
Example:

"LMS-4471"

title
string
Maximum string length: 500
Example:

"Forklift Safety Refresher (2027)"

typeId
string
Example:

"1"

Response

The resource, enveloped.

data
object
required