Tasks

Update a task

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

Tool
filmo_tasks_update
Access: Write

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_tasks_update",
    "arguments": {
      "taskId": "task_8f2a1c"
    }
  }
}

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.

Arguments

taskIdstringRequired

Task identifier.

Limits: min length 1

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

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data
idstring

Unique task identifier.

titlestring

Task title.

descriptionstring | null

Task description or notes; null if it has none.

startDatestring<date-time>

Start date and time in ISO 8601 with offset.

endDatestring<date-time> | null

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

isAllDayboolean

Whether the task is all-day.

isCompletedboolean

Whether the task is completed.

isRecurringboolean

Whether the task is part of a recurring series.

recurringGroupIdstring | null

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

recurrencePatternobject | null

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

Show child attributes
recurrencePattern.frequencystring

Recurrence frequency: daily, weekly, monthly or yearly.

Available options: daily, weekly, monthly, yearly

recurrencePattern.intervalinteger

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

recurrencePattern.endAfterOccurrencesinteger | null

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

recurrencePattern.endDatestring<date-time> | null

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

typestring

Task type (identifier of the type).

assignedStaffIdsstring[]

Identifiers of the staff assigned to the task.

projectIdstring | null

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

relatedDocumentIdstring | null

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

relatedDocumentTypestring | null

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

appearanceobject

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

Show child attributes
appearance.colorstring

Task color in the schedule (hexadecimal code).

appearance.variantstring

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

Available options: primary, secondary, destructive, default

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs PATCH /api/v1/tasks/{taskId}.

  • Tasks

    Update a task

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

  • Guides

    Safe writes

    An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.

  • Guides

    Errors

    A tool error is a result with isError: true and the problem in the first text block. Branch on its code.