Update job

To update a job, send a PATCH request to https://api.planadoapp.com/v2/jobs/:job_id. :job_id can be an external_id or a uuid value. Fields listed in the query will be updated:

$ curl -H "X-Planado-API-Key:XXX" \
       -X PATCH \
       --data "{\"description\": \"Updated description\"}" \
       https://api.planadoapp.com/v2/jobs/8070f98d-b3f6-4cc8-b7c4-54b6709cd98b | jq
{
  "job_uuid": "8070f98d-b3f6-4cc8-b7c4-54b6709cd98b"
}

Request schema

All fields are optional.

Field Type JSON type Required Can be null Description

description

String

String

No

Yes

Text value describing the work to be done. Limited to 15000 characters

scheduled_at

Datetime

String

No

Yes

Planned job start time

scheduled_duration

Duration

Object

No

Yes

Planned job duration

assignee

Assgnee

Object

No

Yes

Worker or team assigned to the job

possible_resolutions

[Resolution]

Array

No

No

List of possible resolutions.
If passed, it must contain at least one successful and one unsuccessful

address

Address

Object

No

No

Address fields

contacts

[Contact]

Array

No

No

List of contacts

client

Client

Object

No

Yes

Client

site

Site

Object

No

Yes

Site

territory

Territory

Object

No

Yes

Territory

skills

[Skill]

Array

No

No

Skills required to complete the job

custom_fields

[Custom field]

Array

No

No

Values of custom job fields

report_fields

[Custom field]

Array

No

No

Values of job report fields

Some of the fields, such as possible_resolutions or assignee, cannot be updated in started jobs.