--- title: "Create an Animal" method: POST path: "/animals" tags: ["Animals & Livestock"] --- # Create an Animal `POST /animals` Create a new animal record ### **Parameters** **type** **`REQUIRED`** Animal type/species. You can specify a custom value for this or use one of the default types: > "Alpaca", "Bees", "Bison", "Buffalo", "Butterflies", "Camel", "Cat", "Catfish", "Cattle", "Chicken", "Crickets", "Deer", "Dog", "Donkey", "Duck", "Elk", "Emu", "Fish", "Gayal", "Goat", "Goose", "Guineafowl", "Horse", "Llama", "Mealworms", "Mollusk", "Mule", "Muskox", "Ostrich", "Partridge", "Peafowl", "Pheasant", "Pig", "Pigeon", "Pony", "Quail", "Rabbit", "Reindeer", "Rhea", "Salmon", "Sheep", "Shellfish", "Silkworms", "Swine", "Tilapia", "Trout", "Turkey", "Water buffalo", "Waxworms", "Yak", "Zebu" --- **status** **`REQUIRED`** The status of the animal or livestock set. Supported values are any of the following: > "Active", "Butchered", "Culled", "Deceased", "Dry", "Lactating", "Lost", "Off Farm", "Quarantined", "Reference", "Sick", "Sold", "Weaning", "Archived" When setting the status to `"Butchered", "Culled", "Deceased",` you must also provide a death_date. And when setting the status to `"Sold"` a `sold_date` is required. --- **name** **`OPTIONAL`** The name or primary identifier for the animal (eg; tag number) --- **tag_number** `OPTIONAL` Animal's primary tag number --- **is_group** **`OPTIONAL`** Specifies if this record is a _livestock set_ used to track multiple animals, without recording data for each animal. Defaulted to `false.`If setting to `true`, you should also set a `group_qty` which stores the initial count of the animals in your set. --- **electronic_id** `OPTIONAL` Electronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite. --- **gender** `OPTIONAL` Sex/gender of the animal. Possible values are `Male` or `Female` --- **bred_status** `OPTIONAL` The current breeding status for a female animal. Supported values are any of the following: > "Open", "Exposed", "Pregnant" When setting `bred_status` to a value other than `Open`, it's recommend to set the `bred_date` value to the date exposed. --- **mother_id** `OPTIONAL` The Farmbrite unique ID for the animal's mother --- **father_id** `OPTIONAL` The Farmbrite unique ID for the animal's father --- **weight** `OPTIONAL` The numeric value of animals current weight in either pounds or kilograms (depending on your account settings). When creating a new record this will create a measurement record for the animal. --- **harvest_unit** `OPTIONAL` The unit used to record harvests for this animal. Supported values are: > "Bales", "Barrels", "Bunches", "Bushels", "Dozen", "Fluid Ounces", "Gallons", "Grams", "Head", "Kilograms", "Kiloliter", "Liter", "Milliliter", "Ounces", "Pounds", "Quantity", "Quarts", "Tonnes", "Tons" The default is to store harvests as `Quantity` --- ### Additional Parameters **birth_date** `OPTIONAL` Birth date - formatted as `YYYY-MM-DD` --- **birth_weight** `OPTIONAL` Numeric value of weight at birth --- **bred_date** `OPTIONAL` Date of last breeding or exposure, formatted as `YYYY-MM-DD` --- **breed** `OPTIONAL` Breed of the animal --- **breeding_stock** `OPTIONAL` Boolean value to allow filter to identify animals that are prime breeding stock --- **coloring** `OPTIONAL` Description of animal color, markings, etc. --- **condition_score** `OPTIONAL` Numeric value used to track body condition score or breed specific scores. Often used for identifying key breeding candidates or for culling. When set, this will create a measurement record for the animal. --- **death_date** `OPTIONAL` Date deceased or culled. Required when setting the status to `"Butchered", "Culled", "Deceased"` - formatted as `YYYY-MM-DD` --- **deceased_reason** `OPTIONAL` Text description for the cause of death. --- **description** `OPTIONAL` Text description of animal --- **harvest_label** `OPTIONAL` Custom label to be used when displaying harvests. For example if harvesting Eggs as Quantity, you may want to set a `harvest_label` to `"eggs"` to show that in harvest reports. --- **is_neutered** `OPTIONAL` Boolean value to indicate if the animal is neutered / intact or not. --- **keywords** `OPTIONAL` A comma delimited string of labels used to easily search for or identify animals. --- **market_price** `OPTIONAL` The default numeric value used when creating new yield record used to calculate the potential harvest revenue based on harvest amounts. --- **on_feed** `OPTIONAL` Boolean value used to identify and filter animals that are on feed for medical or finishing reasons. --- **other_tag_number** `OPTIONAL` Additional tag number to be stored. Can be any string. --- **purchased** `OPTIONAL` Boolean value indicating that the animal was purchased. If set to `true,` then `donated` is automatically set to `false`. --- donated `OPTIONAL` Boolean value indicating that the animal was gifted or donated. If set to `true,` then `purchased` is automatically set to `false`. --- **purchase_date** `OPTIONAL` Date of animal purchase (if applicable) - formatted as `YYYY-MM-DD` --- **purchase_price** `OPTIONAL` Numeric value of amount paid for animal, if purchased. --- **purchased_from_id** `OPTIONAL` The Farmbrite contact unique id that the animal was purchased from (if applicable) --- **donated_date** `OPTIONAL` Date of animal dontaed (if applicable) - formatted as `YYYY-MM-DD` --- **donated_value** `OPTIONAL` Numeric value of estimated value of the animal that was donated, if donated. --- **acquired_from_id** `OPTIONAL` The Farmbrite contact unique id that the animal was dontated or gifted from (if applicable) --- **registry_number** `OPTIONAL` String value to store additional tag or registry identification number(s) --- **retention_score** `OPTIONAL` Numeric value often used to help flag specific animals for potential culling. Useful to filter animals that might be culled. --- **sale_date** `OPTIONAL` Date sold. Required when `status` is set to `"Sold"` - formatted as `YYYY-MM-DD` --- **tag_color** `OPTIONAL` The color (name or hex string) of the tag number --- **internal_id** `OPTIONAL` An internal ID that can be used to identify the animal in addition to the Farmbrite ID and/or other tag numbers. --- **height** `OPTIONAL` A numeric value in inches or centimeter (based on account settings) to store the animal's height. When set will also create a measure record. --- mature_weight `OPTIONAL` A numeric value in pounds or kilograms for the target weight of the animal when fully mature. --- expected_maturity_date `OPTIONAL` The date that the animal is expected to be fully mature. ## Headers - `Content-Type` string ## Request body - object ## Response `200` Successful response --- [API](https://skmtc.net/farmbrite/apis/farmbrite-api-developers-documentation.md) · [All operations](https://skmtc.net/farmbrite/apis/farmbrite-api-developers-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/farmbrite/farmbrite-api-developers-documentation/revisions/b33a389fa2c0/schema)