Skip to main content
POST
/
unified
/
lms
/
users
/
{id}
/
assignments
Create User Assignment
curl --request POST \
  --url https://api.stackone.com/unified/lms/users/{id}/assignments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "learning_object_external_reference": "learning-content-123",
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "external_reference": "e3gd34-23tr21-er234-345er56",
  "learning_object_id": "e3gd34-23tr21-er234-345er56",
  "progress": "40",
  "assigned_at": "2021-07-21T14:00:00.000Z",
  "due_date": "2021-07-21T14:00:00.000Z",
  "status": {
    "value": "in_progress",
    "source_value": "<string>"
  }
}
'
{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Path Parameters

​
id
string
required

Body

application/json
​
learning_object_external_reference
string
required

The external reference of the learning object associated with this assignment, this is the main identifier for creating assignments.

Example:

"learning-content-123"

​
passthrough
object

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }
​
external_reference
string | null
deprecated

The external reference associated with this assignment

Example:

"e3gd34-23tr21-er234-345er56"

​
learning_object_id
string | null

The learning_object_id associated with this assignment. This is not required unless specified in an integration.

Example:

"e3gd34-23tr21-er234-345er56"

​
progress
number | null

The progress associated with this assigment

Example:

"40"

​
assigned_at
string<date-time> | null

The date the assignment was assigned

Example:

"2021-07-21T14:00:00.000Z"

​
due_date
string<date-time> | null

The date the assignment is due to be completed

Example:

"2021-07-21T14:00:00.000Z"

​
status
object

The status of the assignment

Response

The assignment was created successfully.

​
statusCode
number
required
Example:

201

​
message
string
required
Example:

"Record created successfully."

​
timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

​
data
object
required