Create Field Request | Ply | API Documentation

curl -X POST https://api.getply.com/api/v1/field-requests \
     -H "API_KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "locationId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "name": "Need PVC fittings for Job #1204",
  "notes": "Running short on 3/4 inch elbows.",
  "priorityStatus": "HIGH",
  "dueDate": "2026-03-25T17:00:00Z"
}'

{
  "id": "d0e1f2a3-b4c5-6789-defa-890123456789",
  "number": 1042,
  "status": "PENDING",
  "createdAt": "2026-03-20T14:30:00Z",
  "updatedAt": "2026-03-20T14:30:00Z",
  "name": "Need PVC fittings for Job #1204",
  "priorityStatus": "HIGH",
  "notes": "Running short on 3/4 inch elbows.",
  "dueDate": "2026-03-25T17:00:00Z",
  "location": {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "Main Warehouse"
  },
  "createdBy": {
    "id": "e1f2a3b4-c5d6-7890-efab-901234567890",
    "name": "Mike Johnson"
  }
}

Creates a new field request. The request number is auto-generated. Status defaults to PENDING and priority defaults to MEDIUM if not provided.

Requires scope: field_requests:write

Authentication

API_KEYstring

API Key authentication via header

Request

This endpoint expects an object.

locationIdUUIDRequired

ID of the location for this request. Required.

namestringOptional

Name or short description for the field request.

notesstringOptional

Additional notes. Maximum 500 characters.

priorityStatusenumOptional

Priority level. Defaults to MEDIUM.

dueDatedatetimeOptional

ISO 8601 timestamp for when the request is due.

Response

This endpoint returns an object.

idUUID

Unique identifier for the field request.

numberlong

Auto-generated sequential reference number for the field request.

statusenum

Current status of the field request.

createdAtdatetime

ISO 8601 timestamp when the record was created.

updatedAtdatetime

ISO 8601 timestamp when the record was last updated.

namestring

Name or short description of the field request.

priorityStatusenum

Priority level assigned to the field request.

notesstring

Additional notes or details about the request.

dueDatedatetime

ISO 8601 timestamp for when the request is due.

locationobject

Reference to the location associated with this request.

createdByobject

Reference to the user who created the field request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error