Skip to main content
POST
/
users
/
{userId}
/
assignments
curl --request POST \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/assignments' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv' \
--header 'Content-Type: application/json' \
--data '{
"courses": [110, 150],
"deadlineAt": 1704067200
}'
{
    "assignments": [
{
    "assignedAt": 1443183322,
    "startedAt": 0,
    "deadlineAt": 1704067200,
    "finishedAt": 0,
    "progressValue": 0,
    "resultValue": 0,
    "isCourseStarted": false,
    "isCourseFinished": false,
    "isExpired": false,
    "course": {
    "id": 110,
    "name": "Sales Fundamentals",
    "annotation": "Core sales concepts and techniques",
    "isDraft": false,
    "createdAt": 1507807711,
    "updatedAt": 1507808372,
    "publishedAt": 1508225229,
    "image": null
}
}
    ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.konstantly.com/llms.txt

Use this file to discover all available pages before exploring further.

Assign one or more courses to a specific user.

Request Headers

X-API-KEY
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

URL Parameters

userId
string
required
User API ID

Request Body

courses
array
required
Array of course IDs to assign to the user
assignAt
integer
Timestamp when the courses should be assigned (UTC)
deadlineAt
integer
Timestamp for assignment completion deadline (UTC)

Response

assignments
array
required
Array of created course assignments

Error Responses

400
object
Validation error response
404
object
Not Found error response
curl --request POST \
--url 'https://YOURSITE.konstant.ly/openapi/v1/users/1234567890/assignments' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv' \
--header 'Content-Type: application/json' \
--data '{
"courses": [110, 150],
"deadlineAt": 1704067200
}'
{
    "assignments": [
{
    "assignedAt": 1443183322,
    "startedAt": 0,
    "deadlineAt": 1704067200,
    "finishedAt": 0,
    "progressValue": 0,
    "resultValue": 0,
    "isCourseStarted": false,
    "isCourseFinished": false,
    "isExpired": false,
    "course": {
    "id": 110,
    "name": "Sales Fundamentals",
    "annotation": "Core sales concepts and techniques",
    "isDraft": false,
    "createdAt": 1507807711,
    "updatedAt": 1507808372,
    "publishedAt": 1508225229,
    "image": null
}
}
    ]
}