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 order of their rank property. If you try to complete a task out of order, the endpoint returns an HTTP 400 error.

Ranks apply to every task on the enrollment, including internal tasks that Stedi completes. Stedi returns only the tasks assigned to you, so you can receive this error even when you're completing the lowest-ranked task in the response. Visit Complete tasks in rank order to learn how to resolve these errors.

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

Response

application/json

task · Object Required

The updated task record. Text values for the BANK_ACCOUNT_NUMBER and BANK_ROUTING_NUMBER task fields show at most their last four characters. Every other character is replaced with *.

Samples

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"
  }
}

Outline

• Request
  • Path parameters
    • taskId
  • completed
  • responseData
• Response
  • 200UpdateTaskPost
    • task
  • 400ValidationException
  • 401UnauthorizedException
  • 403AccessDeniedException
  • 404ResourceNotFoundException
  • 429QuotaExceededException
  • 500InternalFailureException
  • 503ServiceUnavailableException
  • 504GatewayTimeoutException