P
ProFormsDocs

Update Submission

Update submission metadata — lead status, read/starred flags, conversion value, and notes.

submissions.view
PUT/v1/submissions/:id

Request Body

isReadboolean

Mark as read/unread

isStarredboolean

Star/unstar the submission

leadStatusstring

Lead status: pending, qualified, not_qualified, spam

conversionValuenumber

Monetary value of the conversion

notesstring

Internal notes about the submission

Example Request

curl
curl -X PUT "https://proforms.io/api/v1/submissions/sub_def456" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "isRead": true,
    "isStarred": true,
    "leadStatus": "qualified",
    "conversionValue": 2500,
    "notes": "Interested in premium plan"
  }'

Response

200 OK
{
  "success": true,
  "data": {
    "id": "sub_def456",
    "isRead": true,
    "isStarred": true,
    "leadStatus": "qualified",
    "conversionValue": 2500,
    "notes": "Interested in premium plan"
  }
}

Update Lead Status Only

A dedicated endpoint for updating just the lead status — useful for quick status changes without sending other fields.

PUT/v1/submissions/:id/status

Request Body

status*string

Lead status: pending, qualified, not_qualified, spam

Example Request

curl
curl -X PUT "https://proforms.io/api/v1/submissions/sub_def456/status" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "qualified"
  }'
💡
Valid lead statuses are: pending, qualified, not_qualified, spam.