FIfieldpulse
Jobs

Create a job

Changed on

Create a job

post/jobs

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/jobs
  • Auth
    API key in header x-api-key

Request body

customer_idinteger required

Existing customer id.

project_idinteger nullable

Existing project id.

job_typestring required
subtitlestring
status1 | 2 | 3 | 4 | 5 | 6

Required if status_id is not set. 1 = new, 2 = in progress, 3 = pending, 4 = completed, 5 = canceled, 6 = on the way.

status_idinteger

Required if status is not set. Existing custom status id.

status_workflow_idinteger

Required if status_id is set. Existing status workflow id.

start_timeinteger nullable

Unix timestamp.

end_timeinteger nullable

Unix timestamp.

due_dateinteger nullable

Unix timestamp.

billinginteger required
notesstring
field_notesstring
location_idinteger nullable

Existing location id.

generate_invoiceboolean
type'task' | 'job'
is_templateboolean
in_progress_status_loginteger nullable
template_idinteger nullable

Existing job template id.

hazardco_swms_idinteger nullable

Existing swms file id.

maintenance_agreement_idinteger nullable

Existing maintenance agreement id.

maintenance_occurrence_idinteger nullable

Existing maintenance occurrence id.

recurring_parent_idinteger nullable

Existing job recurring id.

task_category_idinteger nullable

Existing task category id.

customer_contact_idinteger nullable

Existing customer contact id.

tagsinteger[]

Array of tag ids.

customer_arrival_window_start_timeinteger nullable

Unix timestamp.

customer_arrival_window_end_timeinteger nullable

Unix timestamp.

asset_idsinteger[]

Array of existing assets ids.

qb_time_class_idinteger nullable

Existing Quickbooks Time class id.

Response

Created

errorboolean

false when the request succeeds.

responseobject

The created record.

Changes

  • ee9f1d863d51Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the success response with the status