Update Enrollment Task

Updates a task associated with an enrollment.

POST /tasks/{taskId}

This endpoint updates the completion status and data of a task associated with a transaction enrollment.

Stedi adds tasks to an enrollment when specific actions are required to complete the enrollment process. For example, we might add a task to request additional information from the provider.

When the task's responsibleParty is set to PROVIDER, you can use this endpoint to mark the task as completed once the provider has taken the required action. You can also use this endpoint to mark tasks as incomplete if they were marked complete in error.

1. Call this endpoint with the completed property set to true to mark the task as completed. Optionally, provide additional details in the responseData object.

2. The endpoint returns the updated task record.

Stedi displays the task as completed in the Stedi portal and proceeds with the enrollment process.

Task rank order

You must complete tasks in the order defined by their rank property. For example, you can't complete a task with rank 2 if there's an uncompleted task on the enrollment record with rank 1. If you try to complete a task out of order, the endpoint returns an HTTP 400 error.

Authorizations

Authorization · Required Header

A Stedi API Key for authentication.

Path Parameters

taskId · String

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

Body

application/json

completed · Boolean

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

responseData · Object

Additional data you can submit to Stedi when completing a task with definition.provideInformation.

Stedi ignores this object when you complete a task with definition.followInstructions.

provideInformation · responseData.provideInformation · Object Required

Provide notes or confirmation text to Stedi.

response · responseData.provideInformation.response · String Required Min length: 1

Notes or confirmation text from the responsible party in response to completing a ProvideInformation task.

Response

application/json

UpdateTaskPost 200 response

task · Object Required

The updated task record.

completedAt · task.completedAt · String Format: date-time

The timestamp when the task was completed.

responsibleParty · task.responsibleParty · String Required

The party responsible for completing this task.

Possible values

PROVIDER

STEDI

definition · task.definition · Object Required

A definition that determines the task's behavior, requirements, and data.

followInstructions · task.definition.followInstructions · Object Required

A task that requires the responsible party to follow specific instructions.

instructions · task.definition.followInstructions.instructions · String Required Min length: 1

Human-readable instructions for the responsible party to follow.

rank · task.rank · Number Required Range: ≥ 0

The rank order of this task. Tasks with lower numbers must be completed first. For example, a task with rank 1 must be completed before a task with rank 2.

responseData · task.responseData · Object

Data collected when the task was completed. This object currently only applies to tasks with definition.provideInformation.

provideInformation · task.responseData.provideInformation · Object Required

Provide notes or confirmation text to Stedi.

response · task.responseData.provideInformation.response · String Required Min length: 1

Notes or confirmation text from the responsible party in response to completing a ProvideInformation task.

isComplete · task.isComplete · Boolean Required

Whether the task has been marked as complete through either the API or the Stedi portal.

id · task.id · String Required

The unique, Stedi-assigned identifier for the task.

Request

curl --request POST \
  --url "https://enrollments.us.stedi.com/2024-09-01/tasks/{taskId}" \
  --header "Authorization: <api_key>" \
  --header "Content-Type: application/json" \
  --data '{
    "completed": true,
    "responseData": {
      "provideInformation": {
        "response": "I have completed the required steps as instructed."
      }
    }
  }'

Response

{
  "task": {
    "id": "01937d50-1234-7890-abcd-567890abcdef",
    "definition": {
      "provideInformation": {
        "instructions": "Please provide a brief summary of your experience."
      }
    },
    "isComplete": true,
    "completedAt": "2024-06-01T12:00:00Z",
    "responsibleParty": "PROVIDER",
    "rank": 1,
    "responseData": {
      "provideInformation": {
        "response": "I have completed the required steps as instructed."
      }
    }
  }
}