tasks

Update /tasks/{uuid}

Update a task by UUID (PATCH). Only sent fields are updated. Returns record with the detail projection.

PATCH

/tasks/{uuid}

curl --request PATCH \
  --url https://default.hannacrm.app/api/v4/tasks/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignees": [
    "<string>"
  ],
  "billable": "<string>",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "description": "<string>",
  "due_date": "<string>",
  "end_date": "<string>",
  "followers": [
    "<string>"
  ],
  "goal": "<string>",
  "name": "<string>",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "priority": "<string>",
  "rel_type": "<string>",
  "related_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_date": "<string>",
  "status": "<string>",
  "task_type": "<string>"
}
'

{
  "record": {
    "assignees": [
      {}
    ],
    "billable": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "description": "<string>",
    "due_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "finished_date": "2023-11-07T05:31:56Z",
    "followers": [
      {}
    ],
    "goal": "<string>",
    "is_public": "<string>",
    "name": "<string>",
    "organization": [
      {}
    ],
    "organization_name": "<string>",
    "priority": "<string>",
    "rel_type": "<string>",
    "related_title": "<string>",
    "related_uuid": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "status": {
      "color": "<string>",
      "name": "<string>",
      "uuid": "<string>"
    },
    "task_location": "<string>",
    "task_type": [
      {}
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

assigneesstring[]

Assignee staff UUIDs.

billablestring

Whether the task is billable.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

descriptionstring

Task description (HTML allowed).

due_datestring

Due date/time (ISO 8601).

end_datestring

End date/time (ISO 8601).

followersstring[]

Follower staff UUIDs.

goalstring

Task goal picklist value UUID.

namestring

Task title.

organizationstring

Organization UUID.

prioritystring

Task priority: 1 = low, 2 = medium, 3 = high, 4 = urgent. The tasks_priorities picklist value UUID is accepted as well.

rel_typestring

Related entity type (e.g. lead, customer, project). client/clients are accepted as aliases for customer.

UUID of the related entity (requires rel_type).

start_datestring

Start date/time (ISO 8601).

statusstring

Task status picklist value UUID.

task_typestring

Task type picklist value UUID.

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team

Update /tasks/{uuid}

Authorizations

Path Parameters

Body

Response