Blocks

Rename a block or change its paddocks

Renames a block, changes its kind or number, or (with paddock_ids) replaces its members: the listed live paddocks of the property move into it (out of any other block), and a member left out goes back to the home block (block_id null). Omitting paddock_ids leaves the members alone. Writes, moves or removes no record. To move one paddock, updatePaddock with block_id also works. Requires edit rights on the property.

put/properties/{property_id}/blocks/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/properties/{property_id}/blocks/{id}
  • Auth: HTTP bearer

Path parameters

property_idstring uuid required

The property's id.

idstring uuid required

The block's id.

Request body

Response

The updated block.

Example response

{
  "data": {
    "type": "block"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.