STstedi

POST /tasks/{taskId}

Changed on

Updates a task associated with an enrollment.

Request

  • Base URL
    https://enrollments.us.stedi.com/2024-09-01
  • URL
    https://enrollments.us.stedi.com/2024-09-01/tasks/{taskId}
  • Auth
    API key in header Authorization

Path parameters

taskIdstring required

The Stedi-assigned identifier for the task to complete. You can get the task ID from either the Retrieve Enrollment or List Enrollments endpoint.

Request body

completedboolean

Indicates whether the task is completed. Set to true to mark the task as complete. If omitted, the default is false.

Response

UpdateTaskPost 200 response

Changes

  • bc334b77b1eeRevision changes
    • breaking

      removed subschema #1: pdfUpload subschema #2: provideInformation from the request property oneOf list

    • info

      removed subschema #1: followInstructions subschema #2: provideFilledPdf subschema #3: provideInformation from the / response property oneOf list for the response status

    • info

      removed subschema #1: pdfUpload subschema #2: provideInformation from the / response property oneOf list for the response status

  • 0a692cc4f303Revision changes
    • breaking

      the //////// response property's maxLength was increased from 1000 to 5000 for the response status

    • info

      the /////// request property's maxLength was increased from 1000 to 5000

    • info

      response property task/definition/oneOf[subschema #1: followInstructions]/followInstructions deprecated

    • info

      response property task/definition/oneOf[subschema #2: provideFilledPdf]/provideFilledPdf deprecated

    • info

      response property task/definition/oneOf[subschema #3: provideInformation]/provideInformation deprecated