Update Job | Ply | API Documentation

curl -X PUT https://api.getply.com/api/v1/jobs/a1b2c3d4-e5f6-7890-abcd-1234567890ab \
     -H "API_KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "scheduledAt": "2026-06-12T13:00:00",
  "note": "Gate code 4421. Park in the driveway. Customer requested afternoon arrival."
}'

{
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
  "name": "Smith Residence - HVAC Install",
  "createdAt": "2026-05-20T14:32:11",
  "updatedAt": "2026-05-21T10:04:22",
  "number": "JOB-1042",
  "client": {
    "name": "Jane Smith",
    "phoneNumber": "+1-512-555-0142"
  },
  "scheduledAt": "2026-06-12T13:00:00",
  "note": "Gate code 4421. Park in the driveway. Customer requested afternoon arrival.",
  "address": {
    "address": "789 Maple Avenue",
    "suite": null,
    "city": "Austin",
    "state": "TX",
    "zipCode": "78704"
  },
  "active": true,
  "assignedUserIds": [
    "b2c3d4e5-f6a7-8901-bcde-234567890123"
  ]
}

Partially updates a job. Only fields present in the request body are modified — omitted fields are left unchanged. Returns the updated job.

Requires scope: jobs:write

Authentication

API_KEYstring

API Key authentication via header

Path parameters

idUUIDRequired

Job ID.

Request

This endpoint expects an object.

namestringOptional

Updated job name. Maximum 500 characters.

numberstringOptional

Updated job number. Maximum 255 characters.

clientobjectOptional

Updated client contact information.

scheduledAtdatetimeOptional

Updated scheduled timestamp.

notestringOptional

Updated notes. Maximum 5000 characters.

addressobjectOptional

Updated job address.

userIdslist of UUIDsOptional

Replacement list of assigned user IDs.

Response

This endpoint returns an object.

idUUID

Unique identifier for the job.

namestring

Display name of the job.

createdAtdatetime

ISO 8601 timestamp when the record was created.

updatedAtdatetime

ISO 8601 timestamp when the record was last updated.

numberstring

Job number or external reference.

clientobject

Client contact associated with the job.

scheduledAtdatetime

ISO 8601 timestamp for when the job is scheduled.

notestring

Free-form notes attached to the job.

addressobject

Address where the job is performed.

activeboolean

Whether the job is currently active. Archived jobs are returned with false.

assignedUserIdslist of UUIDs

IDs of users (technicians) assigned to this job.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error