Create an Activity

Create a new schedule item

You can create a schedule item at your account level using the /schedule path or under a supported resource (livestock, grow locations or equipment by using the path /:resource_type/:resource_id/activies. For example[GET] /animals/:id/activies will fetch the schedule for this animal.

Parameters

title REQUIRED

The name of your schedule item.

---

start_time REQUIRED

Starting DateTime of your event in 'YYYY-MM-DD HH:MM' format. A value is required if all_day is set to false.

---

end_time REQUIRED

Ending DateTime of your event in 'YYYY-MM-DD HH:MM' format. A value is required if all_day is set to false.

---

assigned_to_id OPTIONAL

The ID or email address of the Farmbrite user to assign the item to.

---

all_day OPTIONAL

Boolean value to indicate the event is all day. Defaults to false.

---

description OPTIONAL

A summary description of the item.

---

reference_type OPTIONAL

Used to link the item to another resource. Supported values are:

"animal", "equipment", "plant", "location"

When providing a reference_type, you should also provide a reference_id. This can also be accomplished by creating the schedule item through its parent resource path. eg; /animals/:animal_id/activies.

---

reference_id OPTIONAL

A Farmbrite ID for the resource type that this record is associated with. This can also be accomplished by creating the schedule item through its parent resource path. eg; /animals/:animal_id/activies.

---

color OPTIONAL

A HEX color value to set the item's color on the calendar or lis view.

---

latitude OPTIONAL

A latitude value used, with longitude, to tag a certain location on the map.

---

longitude OPTIONAL

A longitude value used if wanting to tag a certain location on the map.

{
  "color": "#bdbdbd",
  "title": "Title",
  "description": "",
  "reference_id": "Related Resource ID",
  "reference_type": "Related Resource Type",
  "assigned_to_id": "Farmbrite User ID or Email",
  "latitude": null,
  "longitude": null,
  "start_time": "2026-01-01 11:00",
  "end_time": "2026-01-01 11:30"
}