Skip to content

HighLevel: Update Task

HighLevel contacts.updateTask: arguments, response, policy and SDK examples.

← Contacts operations · Get started

Operation gohighlevel.update_task

Provider route: PUT /contacts/{contactId}/tasks/{taskId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";
async function execute(input: Parameters<HighLevelIntegration["contacts"]["updateTask"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.contacts.updateTask(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.contacts.update_task(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contactIdstringRequired within parent
path.taskIdstringRequired within parent
bodyModelRequired within parentExpand Update Task — request body — body

Referenced models: Update Task — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Task — response body

Referenced models: Get Task — response body

Get Task — response body
FieldTypePresenceDescription and constraints
$objectRoot
taskJSONOptionalTask details
task (allOf 1)ModelAll variants applyExpand Get all Tasks — response body — tasks item

Referenced models: Get all Tasks — response body — tasks item

Update Task — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
assignedTostringOptionalUser Id to whom the task is assigned
bodystringOptionalBody or description of the task
completedbooleanOptionalWhether the task is completed
dueDatestringOptionalDue date of the task (ISO 8601 format)
titlestringOptionalTitle of the task
Get all Tasks — response body — tasks item
FieldTypePresenceDescription and constraints
$objectRoot
assignedTostringOptionalUser Id to whom the task is assigned
bodystringOptionalBody or description of the task
completedbooleanOptionalWhether the task is completed
contactIdstringOptionalContact Id associated with the task
dueDatestringOptionalDue date of the task (ISO 8601 format)
idstringOptionalUnique identifier of the task
titlestringOptionalTitle of the task

SDK function policy ID: gohighlevel.update_task. Catalog operation: update-task. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["contacts.write"]

Pinned headers: {"Version": "v3"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.