> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server.

# Update task

PATCH https://api.joincandidhealth.com/api/tasks/v3/{task_id}
Content-Type: application/json

Reference: https://docs.joincandidhealth.com/api-reference/tasks/v-3/update

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.joincandidhealth.com` (Production, default)
- `https://api-staging.joincandidhealth.com` (Staging)
- `https://sandbox-api.joincandidhealth.com` (CandidSandbox)
- `https://staging-api.joincandidhealth.com` (CandidStaging)
- `http://localhost:5050` (Local)

## Request

### Path parameters

- `task_id` (UUID, required)

### Body (application/json)

This endpoint expects a TaskUpdateV3.

- `status` (enum, optional)
  - Allowed values: `finished`, `addressed_by_provider_group`, `sent_to_provider_group`, `open`, `blocked`, `waiting_for_review`, `in_progress`
- `assignee_user_id` (UUID, optional)
- `blocks_claim_submission` (boolean, optional)

## Response

### 200

- `task_id` (UUID, required)
- `encounter_id` (UUID, required)
- `task_type` (enum, required)
  - Allowed values: `CUSTOMER_DATA_REQUEST`, `CLAIM_SUBMISSION_RUN_VALIDATIONS_FAILURE`, `CLAIM_SUBMISSION_SUBMIT_CLAIM_FAILURE`, `CLAIM_SUBMISSION_TRANSFORM_FAILURE`, `CODE_CLAIM`, `CODE_CLAIM_REVIEW`, `ELIGIBILITY`, `CLAIM_FOLLOW_UP`, `REJECTION_RESOLUTION`, `PAYER_CONFIGURATION_ERROR`, `DENIAL_RESOLUTION`, `MISSING_ENROLLMENT`, `CHARGE_CAPTURE_UPDATE`
- `description` (string, required)
- `blocks_claim_submission` (boolean, required)
- `external_id` (string, required)
- `patient_name` (string, required)
- `patient_external_id` (string, required)
- `status` (enum, required)
  - Allowed values: `finished`, `addressed_by_provider_group`, `sent_to_provider_group`, `open`, `blocked`, `waiting_for_review`, `in_progress`
- `notes` (list of TaskNote, required)
- `created_at` (datetime, required)
- `updated_at` (datetime, required) — The time of most recent update to the task only
- `agg_updated_at` (datetime, required) — The time of most recent update to the task or any of its notes
- `date_of_service` (date, required)
- `assignments` (list of TaskAssignment, required)
- `payer_name` (string, optional)
- `payer_id` (string, optional)
- `category` (enum, optional)
  - Allowed values: `other`, `provider_credentialing`, `authorization_required`, `inactive_coverage`, `unknown_eligibility_or_patient_not_found`, `incorrect_member_id`, `documentation_addendum_request`, `coordination_of_benefits`, `missing_or_incorrect_gender`, `incorrect_date_of_birth`, `incorrect_payer`, `incorrect_name`, `invalid_diagnosis_code`, `non_covered_diagnosis_codes`, `information_requested_from_patient`, `incorrect_rendering_provider_info`, `missing_or_incorrect_modifier`, `coding_frequency_error`, `incorrect_patient_address`, `multiple_em_claims`, `missing_or_incorrect_charge_amount`, `medical_records_request`, `provider_enrollment_or_contracting`, `missing_or_incorrect_group_number`, `missing_diagnosis_codes`, `missing_patient_authorization`, `incorrect_billing_provider_info`, `incorrect_procedure_code`, `incorrect_quantity`, `incorrect_place_of_service_code`, `incorrect_service_facility_info`, `incorrect_date_of_service`, `missing_or_incorrect_ndc`, `patient_collections`, `submit_to_secondary`, `transient_server_error`, `missing_remittance_enrollment`, `missing_claims_enrollment`, `held_by_customer`, `pending_manual_remit_posting`, `incorrect_referring_provider_info`, `payer_configuration_error`, `downcoding_review`
- `configurable_rule_id` (UUID, optional)
- `persisted_rule_id` (UUID, optional)
- `organization_id` (UUID, optional)

## Errors

### 404 Entity Not Found Error

- `errorName` ("EntityNotFoundError", required)
- `content` (EntityNotFoundErrorMessage, required)

### 403 Unauthorized Error

- `errorName` ("UnauthorizedError", required)
- `content` (UnauthorizedErrorMessage, required)

### 422 Task Updated to Deprecated Status Error

- `errorName` ("TaskUpdatedToDeprecatedStatusError", required)
- `content` (TaskUpdatedToDeprecatedStatusErrorType, required)

## Types

### TaskNote

- `task_note_id` (UUID, required)
- `text` (string, required)
- `created_at` (datetime, required)
- `author_name` (string, required)
- `author_organization_name` (string, required)

### TaskAssignment

- `task_assignment_id` (UUID, required)
- `assignee_user_id` (UUID, optional)

### EntityNotFoundErrorMessage

- `id` (string, required)

### UnauthorizedErrorMessage

- `message` (string, optional)

### TaskUpdatedToDeprecatedStatusErrorType

- `deprecated_status` (enum, optional)
  - Allowed values: `finished`, `addressed_by_provider_group`, `sent_to_provider_group`, `open`, `blocked`, `waiting_for_review`, `in_progress`

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "task_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "task_type": "CUSTOMER_DATA_REQUEST",
  "description": "description",
  "blocks_claim_submission": true,
  "external_id": "external_id",
  "patient_name": "patient_name",
  "patient_external_id": "patient_external_id",
  "status": "finished",
  "notes": [
    {
      "task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "text": "text",
      "created_at": "2024-01-15T09:30:00Z",
      "author_name": "author_name",
      "author_organization_name": "author_organization_name"
    },
    {
      "task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "text": "text",
      "created_at": "2024-01-15T09:30:00Z",
      "author_name": "author_name",
      "author_organization_name": "author_organization_name"
    }
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "agg_updated_at": "2024-01-15T09:30:00Z",
  "date_of_service": "2023-01-15",
  "assignments": [
    {
      "task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
    },
    {
      "task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
    }
  ],
  "payer_name": "payer_name",
  "payer_id": "payer_id",
  "category": "other",
  "configurable_rule_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "persisted_rule_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
```

**SDK Code**

```python
import requests

url = "https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

payload = {}
headers = {
    "Authorization": "<token>.",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32';
const options = {
  method: 'PATCH',
  headers: {Authorization: '<token>.', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<token>.")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<token>.'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
  .header("Authorization", "<token>.")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [
  'body' => '{}',
  'headers' => [
    'Authorization' => '<token>.',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "<token>.");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<token>.",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```