Update Ingestion Task
Rename an ingestion task or edit its description after creation. Both
columns are otherwise set only at upload time โ name caller-supplied or
derived from the tags/filename, description caller-supplied or absent.
โถUse Cases
- Give a task a meaningful label after the fact, when the derived tags/filename name turned out to be unhelpful.
- Record why an upload was made, or correct notes attached to it.
โถBody
A partial update โ send only the fields you want to change. A field you omit is left exactly as it was.
| Field | Type | Notes |
|---|---|---|
name | string (1โ255) | Human-friendly label. Cannot be cleared โ it is auto-derived at creation, so there is always a value. Omit the key to leave it unchanged. |
description | string (1โ2000) or null | Free-form notes. Send null to clear the column. |
A body carrying neither field, an unknown key, or name: null is rejected
with 400 VALIDATION_ERROR.
Nothing else about the task is editable here โ in particular
location_type is reconciled from the geometry actually detected during
staging, not user-owned.
โถResponse
The updated task, in exactly the same shape as
Get Ingestion Task (minus the
include=deforestation roll-up), so the response can be swapped straight
into whatever the GET rendered.
Returns 404 when no task with that id belongs to the caller's organization โ the same "exists but not yours" masking the GET applies.
Required scope:
ingestions:write