Addresses1

ApiCredentials6

Asset resources1

Attachments2

Blocks4

BoundaryDrafts8

Categories2

Cities3

Clients6

Compliance exports6

Connection2

Contractors1

Documentation3

Drench records3

Fertiliser records3

Field work records3

Husbandry records3

Image uploads2

LikedContractors3

Locations1

Mobs8

OAuth11

OauthTokens4

Organization Join Links4

Organization Roles8

Organizations6

Paddocks8

Predictions1

Products1

Properties16

PropertySetupDrafts4

Public26

Services8

Sitemap5

Sowing records3

Spray records3

Subscriptions5

Tasks16

Treatment records3

Treatment register1

Users10

Tasks

Update a task

Changed on Oct 31, 2026

A partial write: send only the fields that change. To change a drench's head or products, prefer updateTreatmentRecord (treatment.id, not the task id). drench.products here also replaces the set. created_as is ignored on update. Back-dating uses completed_at with an Australian offset; see createTask.

Attaching a PurpleGrain AI record. To place a record with no asset (filter[unassigned]=true on listTasks), send the asset relationship (a mob or paddock you can edit). The task's property is set from the asset. This works before and after the formatter has run, and on a record with no typed child. A treatment or husbandry record takes a mob; spray, fertiliser, sowing and field work a paddock. Editing a record never queues it for the formatter again.

PurpleGrain AI records are first-party. An MCP client cannot turn a task into one: a request from one that sets operation_type: ai on a task that is not already an AI record is refused with 403 and nothing is written. Sending an AI record's own type back while attaching its asset still passes.

Broadcasting is paused for agents. A request from an API or MCP client whose body names broadcast or share_scope — true or false — is refused with 403 and nothing is written; leave both out. First-party web and mobile requests are unaffected.

Photos. A file on disk is staged with createImageUpload, whose curl_example PUTs the bytes, and attached with image_upload_ids. Never base64-encode a local photo into a tool call. A public http(s) URL: pass image_urls. Only a tiny generated image (under about 100 KB decoded) uses image_base64s. One upload can be attached to several records until it expires. image_mode defaults to append (add to the existing photos); replace swaps them all out; remove_image_ids deletes specific ones (ids from image_ids). If any image fails, the update is rolled back. The attaching call still needs confirm: true.

The MCP tool is refused until it is called again with confirm: true. If the call errors or times out, read the task back before retrying.

patch/tasks/{id}

Request

Base URL
https://api.purplegrain.com/api/v1
URL
https://api.purplegrain.com/api/v1/tasks/{id}
Auth
HTTP bearer

Path parameters

idstring required

Id of the record

Query parameters

includestring

Example:producer,provider,service

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; a path outside the allowed list is refused with 400 unknown_include (see the 400 response); dot notation selects children; max 10 paths. Allowed paths: producer, provider, category, place, place.location, service, service.owner, service.category, service.city, service.place, service.location, property, parent, children, asset.

Request body

Response

Update. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "task"
  }
}

Changes

Oct 31, 2026370fe2f3ed4f Revision changes
- info
  the request property / became optional (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property /////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property /////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property /////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property /////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property /////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property ///////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property /////// (media type: application/vnd.api+json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property ////// (media type: application/json)
- info
  added the new enum value to the request property ////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property ////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property ////// (media type: application/json)
- info
  added the new enum value to the request property ////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property //////// (media type: application/json)
- info
  added the new enum value to the request property ////// (media type: application/json)
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
Oct 30, 2026e32f34ba218b Revision changes
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history (5 revisions)