Update Pick List | Ply | API Documentation

curl -X PUT https://api.getply.com/api/v1/pick-lists/c5d6e7f8-a9b0-1234-cdef-567890123456 \
     -H "API_KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Job #1204 - Phase 2 Materials (Revised)"
}'

{
  "id": "c5d6e7f8-a9b0-1234-cdef-567890123456",
  "name": "Job #1204 - Phase 2 Materials (Revised)",
  "status": "DRAFT",
  "fromLocation": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Main Warehouse",
    "type": "WAREHOUSE"
  },
  "toLocation": {
    "id": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "name": "Job #1204 Site",
    "type": "JOB"
  },
  "materialCount": 3,
  "kitCount": 0,
  "createdAt": "2026-03-20T09:00:00Z",
  "updatedAt": "2026-03-20T15:00:00Z",
  "note": "Needed for rough-in phase",
  "requestDate": "2026-03-25"
}

Updates mutable fields on a pick list. Only fields included in the request body are modified.

Requires scope: pick_lists:write

Authentication

API_KEYstring

API Key authentication via header

Path parameters

idUUIDRequired

Pick list ID.

Request

This endpoint expects an object.

namestringOptional

Updated display name. Maximum 255 characters.

notestringOptional

Updated note. Pass null to clear.

statusenumOptional

Updated status. Returns 400 with a list of valid values if an unrecognized status is provided.

requestDatedateOptional

Updated request date. Pass null to clear.

Response

This endpoint returns an object.

idUUID

Unique identifier for the pick list.

namestring

Display name of the pick list.

statusenum

Current status of the pick list.

fromLocationobject

Source location materials are picked from.

toLocationobject

Destination location materials are transferred to.

materialCountlong

Number of distinct material line items in this pick list.

kitCountlong

Number of kit line items in this pick list.

createdAtdatetime

ISO 8601 timestamp when the record was created.

updatedAtdatetime

ISO 8601 timestamp when the record was last updated.

notestring

Optional note or description for this pick list.

requestDatedate

Requested date for the pick (ISO 8601 date, e.g. 2026-03-25).

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error