PUpurplegrain
Mobs

Update Mob

Changed on

Renaming a mob, or changing its head count, writes a record on its timeline — "Renamed from Merino wethers · Head count set to 1,240 — was 980" — composed on the server, because three write surfaces edit a mob and only the server sees before and after atomically. An update that changes neither field writes nothing.

Archive and restore are this endpoint: archived: true hides the mob from the map and the lists while its records stay on the property; archived: false brings it back. There is no /archive route. Archiving writes no record.

The owning property cannot be changed — a property relationship sent here is ignored, so a mob can never be re-parented and take its records with it. Where the mob IS cannot be set here either; see moveMob.

Requires organization edit rights.

patch/mobs/{id}

Request

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

Path parameters

idstring required

Id of the record

Query parameters

includestring
Example:property.organization

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: property, property.organization.

Request body

Response

Updated

Example response

{
  "data": {
    "type": "mob"
  }
}

Changes

  • 370fe2f3ed4fRevision changes
    • info

      added the optional property /// to the response with the status

  • e32f34ba218bRevision changes
    • info

      added the optional property // to the response with the status