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 "Authorization: Bearer api-key" \
-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 |
---|---|---|---|---|---|
|
String |
String |
No |
Yes |
Text value describing the work to be done. Limited to 15000 characters |
|
Datetime |
String |
No |
Yes |
Planned job start time |
|
Object |
No |
Yes |
Planned job duration |
|
|
Object |
No |
Yes |
Worker or team assigned to the job |
|
|
Array |
No |
No |
List of assignees. |
|
|
Array |
No |
No |
List of possible resolutions. |
|
|
Object |
No |
No |
Address fields |
|
|
[Contact] |
Array |
No |
No |
List of contacts |
|
Object |
No |
Yes |
Client |
|
|
Object |
No |
Yes |
Site |
|
|
Object |
No |
Yes |
Territory |
|
|
[Skill] |
Array |
No |
No |
Skills required to complete the job |
|
Array |
No |
No |
Values of custom job fields |
|
|
Array |
No |
No |
Values of job report fields |
Some of the fields, such as possible_resolutions
, assignees
, or assignee
, cannot be updated in started jobs.
Updating and adding fields
See examples.