Create Mob
A name is a valid mob — the head count arrives when someone counts them. head_count is optional. There are no species, class or breed fields yet; put those in the name (for example "MxBL rams").
Names are unique per property, case-insensitively, across live AND archived mobs: reusing the name of one that was archived is rejected here, where a name is being typed, rather than stranding the archived mob with no way to be restored.
A new mob is not in a paddock. Placement is never set here — it is derived from the mob's records, so the first moveMob is what puts it somewhere. If this call errors or times out, list the property's mobs before retrying. Requires organization edit rights.
Request
- Base URL: https://api.purplegrain.com/api/v1
- URL: https://api.purplegrain.com/api/v1/mobs
- Auth: HTTP bearer
Query parameters
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: farm, farm.organization.
Request body
Response
Created
Example response
{
"data": {
"type": "mob"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.