Sign in
Job Activities

Create a new Job Activity

OAuth Scope

This endpoint requires the following OAuth scope manage_schedule.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/jobactivity.json

Request body

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

job_uuidstring uuid

The UUID of the job this activity belongs to

staff_uuidstring uuid

The UUID of the staff member assigned to this activity

start_datestring

The scheduled start date and time of the activity

end_datestring

The scheduled end date and time of the activity

activity_was_scheduledstring
activity_was_recordedstring
activity_was_automatedstring
has_been_openedstring
has_been_opened_timestampstring
travel_time_in_secondsinteger

The estimated travel time to reach this activity location in seconds

travel_distance_in_metersinteger

The estimated travel distance to reach this activity location in meters

allocated_by_staff_uuidstring uuid
allocated_timestampstring
material_uuidstring uuid

The UUID of the material associated with this activity. Used to determine the cost of the activity.

edit_by_staff_uuidstring uuid

UUID of Staff Member who last modified record

Example request

{
  "uuid": "123e4567-146d-4b3b-8201-231fe8d8249b",
  "edit_date": "2025-08-01 12:00:00",
  "job_uuid": "123e4567-46c2-44aa-8272-231fe389fa9b",
  "staff_uuid": "123e4567-6fb5-4111-8eef-231feb52e4ab",
  "start_date": "2025-08-01 12:00:00",
  "end_date": "2025-08-01 12:00:00",
  "has_been_opened_timestamp": "2025-08-01 12:00:00",
  "allocated_by_staff_uuid": "123e4567-061a-4c62-8536-231fe18e06ab",
  "allocated_timestamp": "2025-08-01 12:00:00",
  "material_uuid": "123e4567-6516-4a80-8b11-231fe862fd7b",
  "edit_by_staff_uuid": "123e4567-7356-4b53-8206-231fe2eb0d5b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes