Skip to main content
Tasks

Update a task

Updates an existing task. Only the fields provided in the request body are changed, and only the rules covering those fields are re-checked — so a task whose linked contact was later archived can still have its status or name updated. An empty body is a successful no-op that returns the task unchanged.

PATCH
/tasks/{id}

Requires the tasks:update scope.

Authorizations

x-api-keystringheaderrequired

Company API key in the format: rotor_{keyId}_{keySecret}

To obtain an API key:

  1. Log into your Rotor dashboard
  2. Go to Settings → Integrations → API Keys
  3. Create a new key and select the scopes you need
  4. Copy the key — it's only shown once!

Path Parameters

idstringrequired

Task ID

Headers

rotor-api-versionenum<string>headerdefault:1.1.0required

Required OpenAPI version header.

Available options: 1.1.0
Example: 1.1.0

Body

application/json
assigned_tostring[]
Maximum array length: 20
contact_idstring | null
contact_typeenum<string> | null
Available options: lead, customer
due_datestring | null
end_datestring | null
namestring
Maximum string length: 255
notesstring | null
Maximum string length: 2000
priorityenum<string>
Available options: low, medium, high
statusenum<string>
Available options: open, in_progress, waiting, done

Response

application/json

Task updated successfully

dataobject
messagestring
Example: Task updated successfully
statusstring
Example: success

Still need help? Ask the team