Get
/CreateCourseAssignment
Allows you to create a course assignment.
Security
API Key: api_key
Header parameter nameapi_key
Query parameters
ExternalId
string
The course assignment's external ID, usually a unique identifier from the calling system
ExampleE3G5YZFREFEQ9371
CourseId
integer (int32) | nullRequired
The Id of the course associated with this course assignment
Example321
UserId
integer (int32) | nullRequired
The UserId of the user that is associated with this course assignment
Example44534
ClubMembershipId
integer (int32)
The subscription (if any) associated with this course assignment
Example1234
Expires
string (date)
When the course assignment expires (as a date string in format yyyy-MM-dd ex: 2025-12-04)
Example2025-12-04
TargetCompletionDate
string (date)
When course assignment is expected to be completed by the student (as a date string in format yyyy-MM-dd ex: 2025-12-04)
Example2025-12-04
Responses
200
OK Response
object
status
integer (int32)
Indicates the status of the API request.
- 0 = Success
- 10 = Error
- 20 = Not found
- 30 = Invalid integration key
Example10
error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
CourseAssignmentId
integer (int32)
The ID of the created course assignment.
Example45632