Update a course assignment by id
    • 16 Jul 2024
    • 1 Minute to read

    Update a course assignment by id


    Article summary

    Get
    /UpdateCourseAssignment

    Allows you to update a course assignment.

    Security
    API Key
    Header parameter nameapi_key
    Query parameters
    Id
    integer (int32) Required

    The ID of the course assignment

    ExternalId
    string

    The course assignment's external ID, usually a unique identifier from the calling system

    CourseId
    integer (int32) Required

    The Id of the course associated with this course assignment

    UserId
    integer (int32) Required

    The UserId of the user that is associated with this course assignment

    ClubMembershipId
    integer (int32)

    The subscription (if any) associated with this course assignment

    Expires
    string (date)

    When the course assignment expires (if ever) (in a string representation of the date)

    TargetCompletionDate
    string (date)

    When course assignment is expected to be completed by the student (in a string representation of the date)

    Started
    string (date)

    When the course assignment was started (if ever) (in a string representation of the date)

    Completed
    string (date)

    When the course assignment was completed (if ever) (in a string representation of the date)

    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).


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.