Action

Patch Action

Changes only the fields you send on an existing Action. Every field you leave out keeps its current value.

Use Patch rather than Update (PUT) whenever you only want to change some values, for example to move a schedule item's dates or a card to another column. Update replaces the Action, so it needs every field sent back.


Patch an Action

HTTP

PATCH https://organisation.fluid.work/rest/api/action/{id}?version=3.0

cURL

curl --user username:patToken --request PATCH 'https://organisation.fluid.work/rest/api/action/4360?version=3.0' \
--header 'Content-Type: application/json' \
--data '{ "fields": { "startDate": "2026-12-01", "endDate": "2026-12-12" } }'

{id} is the Action's id or guid. The response is the updated Action, in the same form as Get Action. The fields, expand and version query parameters work as they do for Update.

How the body is applied

  • Only the names in fields change. A field sent as null is cleared.

  • title is optional, but cannot be sent empty.

  • assignee, owners and viewers: the list you send replaces the current one. [] or null clears it.

  • A name in fields that is not a field is refused with 422, listing the names that can be sent. So is a read-only field that Get returns, such as createDate or modifiedBy: send only the values to change, not a whole Get response.

  • A body that changes nothing is refused with 422.

  • A value that cannot be read, such as a dueDate that is not a date or points that is not a number, is refused with 422 naming the field, and nothing changes. It is not treated as null: to clear a field, send null.

  • customProperties changes only the properties listed. A key that is not one of the Action's custom properties is refused with 422, listing the keys that can be sent, and nothing changes. Keys are matched ignoring case, so region and REGION both set Region. The same custom property sent twice in one request is refused with 422.

Status

  • status can be set. On a board card it must be one of the board's columns (otherwise 422, listing them), and the move must be one the board allows (otherwise 403, and nothing changes). A board owner can move a card to a restricted column.

  • Sending the status the Action already has changes nothing.

  • Archiving is not a status: to archive an Action, use Delete.

Schedule (Gantt) items

  • The dates you send are kept, and the item's effort is recalculated from them on the project calendar, as when you change dates in the Gantt.

  • endDate and dueDate are the same date on a schedule item: send either one. Sending both with different values is refused with 422.

  • A date that falls on a non-working day moves to the next working day.

  • An endDate before the startDate is refused with 422.

  • A milestone has one date. Send startDate or endDate; if you send both, endDate is used. A milestone can be moved earlier or later either way.

  • A ragStatus of Completed completes the item (status Completed at 100%), as in the Gantt. It is refused with 422 on an auto-calculated item, which is completed by its sub-items, and on sites where a Completed RAG is not set by hand: send "status": "Completed" instead.

  • subType must be one of your site's schedule sub types that applies to the item's taskType (otherwise 422, listing them), and is stored with its configured spelling. null or "" clears it. On any other kind of Action a subType is refused with 422.

Board cards

  • On a board with start dates enabled, a startDate later than the dueDate is refused with 422, as in the card dialog. The same day is allowed.

Examples

Move a schedule item's dates

{ "fields": { "startDate": "2026-12-01", "endDate": "2026-12-12" } }

Move a milestone

{ "fields": { "endDate": "2026-12-11" } }

Move a card to another column

{ "fields": { "status": "In Progress" } }

Set a schedule item's sub type

{ "fields": { "subType": "Epic" } }

Set one custom property

{ "customProperties": [ { "key": "Region", "value": "EMEA" } ] }

Clear a field

{ "fields": { "description": null } }

Patch or Update?

Update (PUT)

Patch (PATCH)

Fields left out

Cleared, except title, status, subType and the assignee, owners and viewers lists, which are kept

Kept

title

Required

Optional, cannot be empty

Schedule item dates

Written as sent; the effort is kept

Kept as sent; the effort is recalculated; milestones take one date

Unknown or read-only names in fields

Ignored

Refused with 422

Several Actions in one call

Update Bulk

Not available: one Action per call

Status, custom properties, a Completed RAG, card dates and subType follow the same rules on both.

Responses

Code

Description

200

The updated Action

400

The request body is missing or is not valid JSON

401

Not an authorised user: the username or token is invalid

403

You do not have Editor permission on the Action, or the board does not allow the status move

404

The Action is not found

422

The body is refused; the message says why (see the rules above)

429

Too many requests: see the RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset response headers

Was this article helpful?