Create Job | Ply | API Documentation

curl -X POST https://api.getply.com/api/v1/jobs \
     -H "API_KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Smith Residence - HVAC Install",
  "number": "JOB-1042",
  "client": {
    "name": "Jane Smith",
    "phoneNumber": "+1-512-555-0142"
  },
  "scheduledAt": "2026-06-12T09:00:00",
  "note": "Gate code 4421. Park in the driveway.",
  "address": {
    "address": "789 Maple Avenue",
    "city": "Austin",
    "state": "TEXAS",
    "zipCode": "78704"
  },
  "userIds": [
    "b2c3d4e5-f6a7-8901-bcde-234567890123"
  ]
}'

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

Creates a new job. Returns 201 Created with the created job.

Requires scope: jobs:write

Authentication

API_KEYstring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

Job name. Required. Maximum 500 characters.

numberstringOptional

Job number or external reference. Maximum 255 characters.

clientobjectOptional

Client contact information.

scheduledAtdatetimeOptional

ISO 8601 timestamp for when the job is scheduled.

notestringOptional

Free-form notes. Maximum 5000 characters.

addressobjectOptional

Job address. state accepts the full State enum name (e.g. TEXAS).

userIdslist of UUIDsOptional

IDs of users (technicians) to assign to the job.

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