Docs

Create

POST /Activities

POST/Activities

Creates a new activity record. Activities may be single‑occurrence or recurring, may span multiple locations, and may include users and departments as participants.

Top‑Level Fields

FieldTypeRequiredDescription
typestringRequiredCategory of activity (e.g., Maintenance, Training).
namestringRequiredHuman‑readable name of the activity.
descriptionstringRequiredDetailed description of the activity.
startDateTimeDateTimeRequiredStart timestamp of the activity.
endDateTimeDateTimeRequiredEnd timestamp of the activity.
exactLocationstringRequiredFree‑text location description.
isGlobalboolRequiredWhether the activity applies globally across all locations.
isAllDayboolRequiredWhether the activity spans the entire day.
recurrenceRulesobjectOptionalRecurrence configuration.
locationsList<Guid>OptionalList of location IDs associated with the activity.
usersList<ActivityParticipant>OptionalUser participants.
departmentsList<ActivityParticipant>OptionalDepartment participants.

RecurrenceRules Object

FieldTypeRequiredDescription
frequencystringRequiredRecurrence frequency (Daily, Weekly, Monthly).
intervalintRequiredHow often the recurrence repeats.
daysOfWeekList<string>OptionalDays of the week (for weekly recurrences).
endDateDateTimeRequiredWhen the recurrence stops.

ActivityParticipant Object

FieldTypeRequiredDescription
idGuidRequiredUser or department ID.
isRequiredboolRequiredWhether attendance is mandatory.
rolestringRequiredRole of the participant (e.g., Technician, Supervisor).

Error Codes

CodeHTTP StatusDescriptionRetry
UNAUTHORIZED401Missing or invalid API keyNo
NOT_FOUND404Resource not foundNo
RATE_LIMIT_EXCEEDED429Too many requestsYes
INVALID_REQUEST400Malformed requestNo
INTERNAL_SERVER_ERROR500Unexpected server errorYes