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 updating or completing a task. This is required for manualTask tasks with fields. Use the manualTask object type with a values array. You can update individual field keys across multiple requests without resubmitting every value: supplied values are merged into any previously saved values. Completing the task (completed: true) requires a value for every field. Learn more

manualTask · responseData.manualTask · Object Required

Values provided when updating or completing a manual task. Visit Manage enrollment tasks for details.

values · responseData.manualTask.values · Array of Objects Required Min items : 1

Values for fields in the task definition. Each value's key must have a corresponding field key. When updating a task without completing it, you can submit a subset of fields; the supplied values are merged into any previously saved values. Completing a task (completed: true) requires a value for every field.

key · responseData.manualTask.values[].key · String Required Min length : 1

Identifier that matches a field key in the task definition.

value · responseData.manualTask.values[].value · Object Required

Information to complete the field. It must match the field's fieldType. For example, this might be the provider's Medicaid ID when the fieldType is TEXT.

text · responseData.manualTask.values[].value.text · String Required Length : 1 - 5000

Free-form text when the fieldType is TEXT.

Response

application/json

task · Object Required

The updated task record.

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

The timestamp when the task was completed.

definition · task.definition · Object Required

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

manualTask · task.definition.manualTask · Object Required

A flexible task definition for collecting structured information. It supports text inputs, document uploads, or instruction-only workflows through configurable fields.

fields · task.definition.manualTask.fields · Array of Objects Required

Fields required to complete the task. Each entry defines the key, human-readable label, optional description, and type for values in the response. Can be empty for instruction-only tasks.

description · task.definition.manualTask.fields[].description · String

Additional context explaining what to provide in the response. For example, details about what supporting documentation (such as the provider's W-9 form) is required.

fieldType · task.definition.manualTask.fields[].fieldType · String Required

The type of data to provide in the response. TEXT is for text values that you can provide directly in the response data. For example, a provider identifier. DOCUMENT indicates that the task requires uploading PDF documentation. Only PDF documents are supported. Visit PDF upload document fields for more details.

Possible values

TEXT

DOCUMENT

key · task.definition.manualTask.fields[].key · String Required Min length : 1

A unique identifier for this field within the task, such as ENROLLMENT_FORM.

label · task.definition.manualTask.fields[].label · String Required Min length : 1

Human-readable label for this field, such as Provider NPI or Tax ID.

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

Instructions for completing the task.

links · task.definition.manualTask.links · Array of Objects

Links to help complete the task. This can include payer portals, reference documentation, or document download links for Stedi-provided template PDFs.

label · task.definition.manualTask.links[].label · String Required Min length : 1

Descriptive label for the URL, such as Provider Portal or W-9 Template.

url · task.definition.manualTask.links[].url · String Required Min length : 1

The URL for the resource.

id · task.id · String Required

The unique, Stedi-assigned identifier for the task.

isComplete · task.isComplete · Boolean Required

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

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.

manualTask · task.responseData.manualTask · Object Required

Values provided when updating or completing a manual task. Visit Manage enrollment tasks for details.

values · task.responseData.manualTask.values · Array of Objects Required Min items : 1

Values for fields in the task definition. Each value's key must have a corresponding field key. When updating a task without completing it, you can submit a subset of fields; the supplied values are merged into any previously saved values. Completing a task (completed: true) requires a value for every field.

key · task.responseData.manualTask.values[].key · String Required Min length : 1

Identifier that matches a field key in the task definition.

value · task.responseData.manualTask.values[].value · Object Required

Information to complete the field. It must match the field's fieldType. For example, this might be the provider's Medicaid ID when the fieldType is TEXT.

text · task.responseData.manualTask.values[].value.text · String Required Length : 1 - 5000

Free-form text when the fieldType is TEXT.

responsibleParty · task.responsibleParty · String Required

The party responsible for completing this task.

Possible values

PROVIDER

STEDI

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": {
      "manualTask": {
        "values": [
          {
            "key": "medicaidId",
            "value": {
              "text": "ABCD12"
            }
          }
        ]
      }
    }
  }'

Response

{
  "task": {
    "completedAt": "2024-06-01T12:00:00Z",
    "definition": {
      "manualTask": {
        "fields": [
          {
            "fieldType": "TEXT",
            "key": "medicaidId",
            "label": "Medicaid Provider Identifier"
          }
        ],
        "instructions": "Please provide your Medicaid Provider Identifier."
      }
    },
    "id": "01937d50-1234-7890-abcd-567890abcdef",
    "isComplete": true,
    "rank": 1,
    "responseData": {
      "manualTask": {
        "values": [
          {
            "key": "medicaidId",
            "value": {
              "text": "ABCD12"
            }
          }
        ]
      }
    },
    "responsibleParty": "PROVIDER"
  }
}