Create a Job

post https://api.tidy.com/api/v1/jobs

Creates a Job.

To create a Job you must enter a start_no_earlier_than and end_no_later_than attribute. This represents the range of times you want a pro to accept your request to complete a service.

Another optional attribute is the preferred_start_datetime. This attribute means the specific time you want for your job, if its possible. If this time is not available, then TIDY will try any other time in the range you set for start_no_earlier_than and end_no_later_than. Unless you have a strong preference, we recommend selecting the time as early as possible in your range of times. This gives more time to resolve any issues, should one occur.

The preferred_start_datetime must within the start_date_no_earlier_than and end_no_later_than.

The start_date_no_earlier_than date must be within 6 days of the end_no_later_than date.

If the preferred_start_datetime is not given, it will be filled by the start_date_no_eaelier_than.

Body Params

address_id

integer

required

to_do_list_id

integer

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 use the default to-do list on your account.

service_type_key

string

required

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

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.

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.

preferred_start_datetime

object

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.

If this parameter is not given, it will be filled by the start_date_no_eaelier_than.

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

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 POST \
2
     --url https://api.tidy.com/api/v1/jobs \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "service_type_key": "regular_cleaning.one_hour"
8
}
9
'

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

application/json

201Created