Tasks

Broadcast Task

Paused for agents. Sharing with local contractors is switched off in the product: API and MCP clients receive 403 and the MCP server does not list this operation. First-party web and mobile requests still work, so installed apps keep working.

Share the task with local contractors — sets share_scope to broadcast (broadcast: true). Free; nothing is billed and the legacy payment fields are not written. Kept as an alias of PUT /tasks/{id} with { broadcast: true }; to un-share, send that PUT with { broadcast: false }.

post/tasks/{id}/broadcast

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/tasks/{id}/broadcast
  • 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; 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. 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 5 revisions of this API.