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

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

Boolean flag indicating whether this activity was scheduled in advance. Cannot be true if activity_was_recorded is true.

activity_was_recordedstring

Boolean flag indicating whether this activity was recorded after completion rather than scheduled in advance. Cannot be true if activity_was_scheduled is true.

activity_was_automatedstring

Integer flag indicating if the activity was automated: 0

has_been_openedstring

Boolean flag indicating whether the assigned staff member has viewed this job activity. Resets to false if the staff member or start time is changed. Only relevant when activity_was_scheduled is true.

has_been_opened_timestampstring

The date and time when the assigned staff member first viewed this job activity. Format is YYYY-MM-DD HH:MM:SS. Resets when staff member or start time is changed. Only relevant when activity_was_scheduled is true.

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

{"stackTrail":"components:schemas:JobActivityCreate:properties:allocated_by_staff_uuid","oasType":"schema","type":"unknown","description":"DEPRECATED"}
{"stackTrail":"components:schemas:JobActivityCreate:properties:allocated_timestamp","oasType":"schema","type":"unknown","description":"DEPRECATED"}
material_uuidstring uuid

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

uuidstring uuid

Unique identifier for this record

edit_by_staff_uuidstring uuid

UUID of Staff Member who last modified record

Example request

{
  "job_uuid": "123e4567-4574-4f07-8a7e-23f94f76144b",
  "staff_uuid": "123e4567-d648-48f1-9223-23f94b0c350b",
  "start_date": "2026-03-01 12:00:00",
  "end_date": "2026-03-01 12:00:00",
  "has_been_opened_timestamp": "2026-03-01 12:00:00",
  "material_uuid": "123e4567-24bc-41d2-91d5-23f9493d724b",
  "uuid": "123e4567-1330-427d-a253-23f94562fb8b",
  "edit_by_staff_uuid": "123e4567-e22b-4b03-952b-23f943c0658b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 3 of the 50 revisions of this API.414

  • 638a8df09bf421See the full diff
    • ▲

      the allocated_by_staff_uuid request property type/format changed from string/uuid to /

      request-property-type-changed

    • ▲

      the allocated_timestamp request property type/format changed from string/ to /

      request-property-type-changed

    • ●

      removed the request property active

      request-property-removed

  • ca9b053c43734See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • f2e41074a4682See the full diff
    • ▲

      the travel_distance_in_meters request property type/format changed from string/ to integer/

      request-property-type-changed

    • ▲

      the travel_time_in_seconds request property type/format changed from string/ to integer/

      request-property-type-changed