> ## Documentation Index
> Fetch the complete documentation index at: https://exsited.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a checklist item

> Changes one checklist item and returns the task.

Send the fields to change under `checklist`, as an object, such as a new `name`. The path takes the task's `id` or `code`. The task comes back under `work_task`.

> [!NOTE]
>
> The SDK samples get their client from credentials your app registers once when it starts, as shown in [Authentication](https://exsited.mintlify.site/authentication.md#set-up-a-client). To try the call here, click **Try it**, set `host` to your Exsited API host name and paste an access token from [Get an access token](https://exsited.mintlify.site/api-reference/authentication/get-an-access-token.md). To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its `-d` payload.


## OpenAPI

````yaml PATCH /tasks/{task_id}/checklist/{task_checklist_uuid}
openapi: 3.1.0
info:
  title: Exsited API
  version: v4
servers:
  - url: https://{host}/api/v4
    variables:
      host:
        default: your-api-host.example.com
        description: Your Exsited API host name, without https://.
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Accounts
  - name: Account emails
  - name: Account groups
  - name: Communications
  - name: Communication profiles
  - name: Orders
  - name: Quote orders
  - name: Express
  - name: Usages
  - name: Sales reps
  - name: Gift certificates
  - name: Invoices
  - name: Pro-forma invoices
  - name: Payments
  - name: Refunds
  - name: Credit notes
  - name: Credit note applications
  - name: Reconciliations
  - name: Items
  - name: Inventory adjustments
  - name: Units of measurement
  - name: Zones
  - name: Shipping packages
  - name: Shipping rules
  - name: Fulfillment profiles
  - name: Fulfillment terms
  - name: Item fulfillments
  - name: Item receipts
  - name: Bookings
  - name: Rental assets
  - name: Return merchandise authorisations
  - name: Purchase orders
  - name: Purchase invoices
  - name: Purchase payments
  - name: Purchase refunds
  - name: Purchase credit notes
  - name: Purchase credit note applications
  - name: Purchase express
  - name: Return vendor authorizations
  - name: ABA files
  - name: Receive terms
  - name: Labours
  - name: Tasks
  - name: Timesheets
  - name: Milestones
  - name: Employees
  - name: Departments
  - name: Designations
  - name: Teams
  - name: Time periods
  - name: Workflows
  - name: Workflow settings
  - name: Events
  - name: Custom events
  - name: System events
  - name: Approvals
  - name: Approval profiles
  - name: Approval user groups
  - name: Alerts
  - name: Alert responsibility settings
  - name: Alert responsibilities
  - name: Action scripts
  - name: Note groups
  - name: Note attachments
  - name: Instance settings
  - name: Accounting codes
  - name: Additional codes
  - name: Billing periods
  - name: Charging periods
  - name: Pricing periods
  - name: Invoice terms
  - name: Days of the month
  - name: Countries
  - name: Salutations
  - name: Document templates
  - name: Email templates
  - name: Roles
  - name: Operators
  - name: Operator groups
  - name: User settings
  - name: Custom attributes
  - name: Custom components
  - name: Custom features
  - name: Custom fields
  - name: Custom forms
  - name: Attribute attachments
  - name: Portal
  - name: Integration connections
  - name: External databases
  - name: Reports
  - name: Applications
  - name: Organisation
  - name: Child organisations
  - name: Webhooks
paths:
  /tasks/{task_id}/checklist/{task_checklist_uuid}:
    patch:
      tags:
        - Tasks
      summary: Update a checklist item
      description: >-
        Send the fields to change under `checklist`, as an object, such as a new
        `name`. The path takes the task's `id` or `code`. The task comes back
        under `work_task`.
      operationId: tasks_update_task_checklist_by_uuid
      parameters:
        - name: task_id
          in: path
          required: true
          description: The task's `id`, which starts with `wt_`, or its `code`.
          schema:
            type: string
        - name: task_checklist_uuid
          in: path
          required: true
          description: The checklist item's `id`.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                checklist:
                  type: object
                  properties:
                    name:
                      type: string
              required:
                - checklist
            example:
              checklist:
                name: Measure and mark the fence line
      responses:
        '200':
          description: The task, under `work_task`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskViewResponse'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X PATCH
            "$EXSITED_BASE_URL/api/v4/tasks/wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b/checklist/3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN" \
              -H "Content-Type: application/json" \
              -d '{
                "checklist": {
                  "name": "Measure and mark the fence line"
                }
              }'
        - lang: python
          label: Python
          source: |
            from exsited import build_client

            client = build_client()

            response = client.tasks.update_task_checklist_by_uuid(
                "wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b",
                "3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b",
                {"checklist": {"name": "Measure and mark the fence line"}},
            )
            print(response.data)
        - lang: javascript
          label: JavaScript
          source: |
            import {buildClient} from 'exsited';

            const client = await buildClient();

            const response = await client.tasks.updateTaskChecklistByUuid(
                'wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b',
                '3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b',
                {checklist: {name: 'Measure and mark the fence line'}},
            );
            console.log(response.data);
        - lang: php
          label: PHP
          source: |
            use Exsited\Client\ClientRegistry;

            $client = ClientRegistry::buildClient();

            $response = $client->tasks->updateTaskChecklistByUuid(
                'wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b',
                '3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b',
                ['checklist' => ['name' => 'Measure and mark the fence line']],
            );
            print_r($response->data);
        - lang: java
          label: Java
          source: >
            import com.exsited.client.ApiResponse;

            import com.exsited.client.ClientRegistry;

            import com.exsited.client.ExsitedClient;

            import com.exsited.resources.tasks.tasks_dto.TasksDto.TaskView;

            import java.util.Map;


            ExsitedClient client = ClientRegistry.buildClient();


            ApiResponse<TaskView> response =
            client.tasks().updateTaskChecklistByUuid(
                    "wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b",
                    "3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b",
                    Map.of("checklist", Map.of("name", "Measure and mark the fence line")));
            System.out.println(response.getMap());
        - lang: csharp
          label: .NET
          source: |
            using Exsited.Client;

            await using var client = ExsitedClient.BuildClient();

            var response = await client.Tasks.UpdateTaskChecklistByUuidAsync(
                "wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b",
                "3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b",
                new Dictionary<string, object?>
                {
                    ["checklist"] = new Dictionary<string, object?>
                    {
                        ["name"] = "Measure and mark the fence line",
                    },
                });

            Console.WriteLine(response.Json);
        - lang: dart
          label: Dart
          source: |
            import 'package:exsited/exsited.dart';

            final client = buildClient();

            final response = await client.tasks.updateTaskChecklistByUuid(
              'wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b',
              '3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b',
              {
                'checklist': {'name': 'Measure and mark the fence line'},
              },
            );
            print(response.map);
        - lang: go
          label: Go
          source: "import (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\texsited \"github.com/exsited/exsited-sdk-go/v4\"\n)\n\nclient, err := exsited.BuildClient(nil)\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer client.Close()\n\nresponse, err := client.Tasks().UpdateTaskChecklistByUUID(context.Background(), \"wt_2e4f6a8b0c1d4e3f9a7b5c3d1e0f2a4b\", \"3f1c2b4a-5d6e-4f70-8a9b-0c1d2e3f4a5b\", map[string]any{\n\t\"checklist\": map[string]any{\"name\": \"Measure and mark the fence line\"},\n}, nil)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Println(response.Map)\n"
components:
  schemas:
    TaskViewResponse:
      type: object
      properties:
        work_task:
          $ref: '#/components/schemas/TaskView'
    TaskView:
      type: object
      properties:
        activity_logs:
          type: array
          items:
            $ref: '#/components/schemas/TaskViewActivityLog'
        actual_hours:
          type: 'null'
        alerts:
          type: array
        assignees:
          $ref: '#/components/schemas/TaskViewAssignees'
        checklist:
          type:
            - array
            - object
          description: >-
            The checklist items: an array on the task and on the checklist list,
            and a single item object when you retrieve one checklist item.
        code:
          type: string
        completed_at:
          type: string
        completed_by:
          $ref: '#/components/schemas/TaskViewCompletedBy'
        created_by:
          $ref: '#/components/schemas/TaskViewCreatedBy'
        created_on:
          type: string
        custom_attributes:
          type: array
        description:
          type: string
        display_name:
          type: string
        due_date:
          type: string
        estimated_hours:
          type: integer
        href:
          type: string
        id:
          type: string
        last_updated_by:
          $ref: '#/components/schemas/TaskViewLastUpdatedBy'
        last_updated_on:
          type: string
        milestone:
          type: 'null'
        name:
          type: string
        object:
          type: string
        parent_task:
          type: 'null'
        priority:
          type: string
        resource:
          type: 'null'
        sort_order:
          type: integer
        start_after:
          type: 'null'
        start_date:
          type: string
        state:
          type: 'null'
        status:
          type: string
        task_status:
          type: string
        version:
          type: integer
        workflow:
          type: 'null'
    TaskViewActivityLog:
      type: object
      properties:
        activity:
          type: string
    TaskViewAssignees:
      type: object
      properties:
        manually_added_account_contacts:
          type: array
        selected_account_contacts:
          type: array
        selected_employees:
          type: array
          items:
            $ref: '#/components/schemas/TaskViewAssigneesSelectedEmployee'
        selected_labours:
          type: array
          items:
            $ref: '#/components/schemas/TaskViewAssigneesSelectedLabour'
        selected_operators:
          type: array
    TaskViewCompletedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    TaskViewCreatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    TaskViewLastUpdatedBy:
      type: object
      properties:
        name:
          type: string
        object:
          type: string
    TaskViewAssigneesSelectedEmployee:
      type: object
      properties:
        display_order:
          type: integer
        email:
          type: string
        employee_code:
          type: string
        name:
          type: string
        responsibility:
          type: 'null'
        uuid:
          type: string
    TaskViewAssigneesSelectedLabour:
      type: object
      properties:
        display_order:
          type: integer
        email:
          type: string
        labour_code:
          type: string
        name:
          type: string
        responsibility:
          type: 'null'
        uuid:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An access token from `POST /api/v4/oauth2/token`. The SDKs get and renew
        it for you.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.