Update a Job

put https://api.tidy.com/api/v1/jobs/{job_id}

Updates a job to the values of the parameters passed. Any parameters not provided will be left unchanged.

Most people use this to update to-do lists.

The Update Jobs endpoint can be used for minor adjustments to the times a job can occur. Any start or end date changes must be to a date within 3 days of the current scheduled datetime or preferred datetime. Use the reschedule endpoint to make major changes including changing the scheduled or preferred date of the job.

Path Params

job_id

integer

required

Job ID to perform action

Body Params

to_do_list_id

integer | null

The id for the to-do list. Learn more: https://help.tidy.com/to-do-lists

If you pass a to-do list id:
The pro will see that list when doing the job.

If you pass this parameter with an null value:
The pro will not see any to-dos in this job.

If you don't pass this parameter at all:
We will not change the existing value for this job.

start_no_earlier_than

object

First time a job can be scheduled to start. The Update Jobs endpoint can be used for minor adjustments to the times a job can occur. Any start or end date changes must be to a date within 3 days of the current scheduled datetime or preferred datetime. Use the reschedule endpoint to make major changes including changing the scheduled or preferred date of the job.

end_no_later_than

object

Latest time a Job can be scheduled to finish. The Update Jobs endpoint can be used for minor adjustments to the times a job can occur. Any start or end date changes must be to a date within 3 days of the current scheduled datetime or preferred datetime. Use the reschedule endpoint to make major changes including changing the scheduled or preferred date of the job.

Response

Response body

object

string

required

Defaults to job

Type of object being returned

integer

required

Unique identifier for the Job

address_id

integer

required

Unique identifier for the Address this Job belongs to

to_do_list_id

integer | null

required

Unique identifier for the To-Do List.

status

string

required

The Status of the Job

scheduled in_progress completed cancelled failed

price

integer

required

Price of the Job in cents. Ex. 1000 -> $10.00

is_partially_completed

boolean

required

True when Job has more than one Pro and one Pro makerd the Job as completed.

cancelled_by

string | null

required

Who cancelled the Job

customer pro

service_type_key

string

required

Service Type key of Job. This will identify the service_type and how many hours the job will have

regular_cleaning.one_hour regular_cleaning.two_and_a_half_hours regular_cleaning.four_hours

url

string

required

This is a link to the Job in the TIDY console/app. If it is past, it will direct you to details about the past Job. If the Job is scheduled or ongoing, it will take you to the Job with the ability to take further action.

current_start_datetime

object

required

The current date and time that a Job is scheduled as a confirmed time with a Pro. In other words, some Pro said "I am coming at this time".

date

required

Formatted like YYYY-MM-DD. Example: "2020-01-01".

time

string

required

Formatted HH:MM, in intervals of 30 minutes. Example: "08:00" or "13:30" but NOT "14:47".

preferred_start_datetime

object

required

This is the preferred time a Pro could show up, if possible. We recommend adding the earliest possible time possible unless you have a strong preference. For example: If Monday 8:00am is the earliest a Pro could do the job, by Tuesday 11:00am is preferred, insert Tuesday 11:00am here.

date

required

Formatted like YYYY-MM-DD. Example: "2020-01-01".

time

string

required

Formatted HH:MM, in intervals of 30 minutes. Example: "08:00" or "13:30" but NOT "14:47".

start_no_earlier_than

object

required

This is the earliest a job can be scheduled for. For example: If Monday 8:00am is the earliest a Pro could do the job, insert that here.

date

required

Formatted like YYYY-MM-DD. Example: "2020-01-01".

time

string

required

Formatted HH:MM, in intervals of 30 minutes. Example: "08:00" or "13:30" but NOT "14:47".

end_no_later_than

object

required

This is the latest time a job can be finished on the property. For example: If a Pro must absolutely be gone by Friday 5:00pm, insert that here.

date

required

Formatted like YYYY-MM-DD. Example: "2020-01-01".

time

string

required

Formatted HH:MM, in intervals of 30 minutes. Example: "08:00" or "13:30" but NOT "14:47".

created_at

string

required

Date and time of when the Job was created. UTC and ISO formatted

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.tidy.com/api/v1/jobs/job_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK