Tasks

Delete all of a task's photos

Removes the whole gallery in one call, including any legacy single image. The path id is the task id. To remove one photo, use deleteTaskImage with image_id from the task's image_ids.

delete/tasks/{id}/images

Request

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

Path parameters

idstring required

Id of the task.

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; unknown paths ignored; 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, farm, parent, children, asset.

Response

Success — the task with an empty gallery. 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

No recorded changes to this operation across all 2 revisions of this API.