Update Field Request | Ply | API Documentation

curl -X PUT https://api.getply.com/api/v1/field-requests/d0e1f2a3-b4c5-6789-defa-890123456789 \
     -H "API_KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "notes": "Also need 1/2 inch elbows — added to the request."
}'

{
  "id": "d0e1f2a3-b4c5-6789-defa-890123456789",
  "number": 1042,
  "createdAt": "2026-03-20T08:00:00",
  "updatedAt": "2026-03-20T14:35:00",
  "name": "Need PVC fittings for Job #1204",
  "status": "PENDING",
  "priorityStatus": "HIGH",
  "notes": "Also need 1/2 inch elbows — added to the request.",
  "dueDate": "2026-03-25T17:00:00",
  "location": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Main Warehouse"
  },
  "createdBy": {
    "id": "e1f2a3b4-c5d6-7890-efab-901234567890",
    "name": "Mike Johnson"
  }
}

Updates mutable fields on an existing field request. Only fields included in the request body are modified.

Requires scope: field_requests:write

Authentication

API_KEYstring

API Key authentication via header

Path parameters

idUUIDRequired

Field request ID.

Request

This endpoint expects an object.

namestringOptional

Updated name or short description.

locationIdUUIDOptional

Updated location ID.

notesstringOptional

Updated notes. Maximum 500 characters. Omitted or null leaves the current value unchanged.

dueDatedatetimeOptional

Updated due date. Omitted or null leaves the current value unchanged.

Response

This endpoint returns an object.

idUUID

Unique identifier for the field request.

numberlong

Auto-generated sequential reference number for the field request.

createdAtdatetime

ISO 8601 timestamp when the record was created.

updatedAtdatetime

ISO 8601 timestamp when the record was last updated.

namestringOptional

Name or short description of the field request.

statusenumOptional

Current status of the field request.

priorityStatusenumOptional

Priority level assigned to the field request.

Allowed values:

notesstringOptional

Additional notes or details about the request.

dueDatedatetimeOptional

ISO 8601 timestamp for when the request is due.

locationobjectOptional

Reference to the location associated with this request.

createdByobjectOptional

Reference to the user who created the field request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Rate Limit Error