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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Job Activity record to create

uuid

The UUID of the job this activity belongs to

uuid

The UUID of the staff member assigned to this activity

string

The scheduled start date and time of the activity

string

The scheduled end date and time of the activity

string

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

string

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

string

Integer flag indicating if the activity was automated: 0

string

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.

string

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.

integer

The estimated travel time to reach this activity location in seconds

integer

The estimated travel distance to reach this activity location in meters

string

DEPRECATED

string

DEPRECATED

uuid

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

uuid

Unique identifier for this record

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json