Tasks

Update a task

Partially updates a task (send only the fields to change).

PATCH

/api/v1/tasks/{taskId}

curl https://app.filmo.io/api/v1/tasks/task_8f2a1c \
  --request PATCH \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "isCompleted": true,
  "assignedStaffIds": [
    "stf_ana"
  ]
}'

Node.jsfetch('https://app.filmo.io/api/v1/tasks/task_8f2a1c', { method: 'PATCH', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ isCompleted: true, assignedStaffIds: ['stf_ana'] }) })Pythonimport uuid import requests requests.patch( "https://app.filmo.io/api/v1/tasks/task_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "isCompleted": True, "assignedStaffIds": [ "stf_ana" ] } )

{
  "data": {
    "id": "task_9f3a2b",
    "title": "Example title",
    "description": "Example text.",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "isAllDay": true,
    "isCompleted": true,
    "isRecurring": true,
    "recurringGroupId": "recurring_group_9f3a2b",
    "recurrencePattern": {
      "frequency": "daily",
      "interval": 1,
      "endAfterOccurrences": 1,
      "endDate": "2026-09-01T08:00:00.000Z"
    },
    "type": "Example type",
    "assignedStaffIds": [
      "assigned_staff_9f3a2b"
    ],
    "projectId": "project_9f3a2b",
    "relatedDocumentId": "related_document_9f3a2b",
    "relatedDocumentType": "Example related document type",
    "appearance": {
      "color": "Example color",
      "variant": "primary"
    },
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "tasks:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

The staff, the project and the related document are checked against your account just as on creation. Returns the updated task.

Authorizations

Bearer API key with the scope below. tasks:write

Headers

Idempotency-Keystring

Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 validation_error, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the Idempotent-Replay: true header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout.

Limits: min length 1, max length 255

Example:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Optimistic locking: the ETag you read from the resource (or *). If the resource changed since, the write is rejected with 412 precondition_failed before doing anything; read it again and retry. Without the header the write always proceeds.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

taskIdstringRequired

Task identifier.

Limits: min length 1

Body

application/json

Body schema: TaskUpdateBody

titlestring

Task title.

Limits: min length 1, max length 300

descriptionstring | null

Task description or notes; null clears it.

Limits: max length 5000

startDatestring<date-time>

Task start date and time (ISO 8601 with offset).

endDatestring<date-time> | null

Task end date and time (ISO 8601 with offset); must be equal to or later than startDate. null clears it.

isAllDayboolean

Whether the task is all-day.

isCompletedboolean

Marks the task as completed or pending.

typestring

Task type: its identifier or its name, matched ignoring case and accents (see POST /api/v1/tasks). Changing it also changes the color of the task to that of the type.

Limits: min length 1, max length 100

assignedStaffIdsstring[]

Identifiers of the staff assigned to the task (max 50); replaces the existing assignment.

Limits: max 50 items, each min length 1, each max length 100

projectIdstring | null

Identifier of the linked project; null unlinks it.

Limits: min length 1, max length 100

relatedDocumentIdstring | null

Identifier of the related document; always goes together with relatedDocumentType. null (with relatedDocumentType: null) unlinks it.

Limits: min length 1, max length 100

relatedDocumentTypestring | null

Type of the related document; always goes together with relatedDocumentId. null (with relatedDocumentId: null) unlinks it.

Available options: contact, order, item, kit, space, collection, invoice, quote, purchaseOrder, supplierInvoice, incident, repairTicket, project, vehicle, staff, service, opportunity

Response

application/json

Successful response.

Response schema: TaskDto

Envelope: TaskResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

The task, as returned by the API.

Show child attributes

data.idstring

Unique task identifier.

data.titlestring

Task title.

data.descriptionstring | null

Task description or notes; null if it has none.

data.startDatestring<date-time>

Start date and time in ISO 8601 with offset.

data.endDatestring<date-time> | null

End date and time in ISO 8601 with offset; null if it has no defined end.

data.isAllDayboolean

Whether the task is all-day.

data.isCompletedboolean

Whether the task is completed.

data.isRecurringboolean

Whether the task is part of a recurring series.

data.recurringGroupIdstring | null

Identifier of the recurrence group it belongs to; null if it is not recurring.

data.recurrencePatternobject | null

Recurrence pattern of the task; null if it is not recurring.

Show child attributes

data.recurrencePattern.frequencystring

Recurrence frequency: daily, weekly, monthly or yearly.

Available options: daily, weekly, monthly, yearly

data.recurrencePattern.intervalinteger

Interval between repetitions according to the frequency (e.g. 2 with weekly = every two weeks).

data.recurrencePattern.endAfterOccurrencesinteger | null

Number of repetitions after which the recurrence ends; null if it does not end by number of occurrences.

data.recurrencePattern.endDatestring<date-time> | null

Date on which the recurrence ends, in ISO 8601 with offset; null if it does not end by date.

data.typestring

Task type (identifier of the type).

data.assignedStaffIdsstring[]

Identifiers of the staff assigned to the task.

data.projectIdstring | null

Identifier of the linked project; null if the task is not linked.

data.relatedDocumentIdstring | null

Identifier of the related document; null if it has none.

data.relatedDocumentTypestring | null

Type of the related document (contact, order, invoice, quote, project, etc.); null if it has none.

data.appearanceobject

Appearance of the task in the schedule (color and variant).

Show child attributes

data.appearance.colorstring

Task color in the schedule (hexadecimal code).

data.appearance.variantstring

Visual variant of the task: primary, secondary, destructive or default.

Available options: primary, secondary, destructive, default

data.createdAtstring<date-time>

Creation date in ISO 8601 with offset.

data.updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
400	`validation_error`	Malformed query or body. `errors[]` lists every offending field with its stable code.
404	`not_found`	It does not exist or is outside the scope of the API key.
409	`conflict`	The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation.
412	`precondition_failed`	The `If-Match` entity tag does not match the current representation. Read the resource again and retry.
422	`idempotency_key_reused`	The same key was used before with a different body. Change the key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Operations
Task
The task, as returned by the API.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Body

Response

Errors

Deprecation

Related

Related pages

Task