Update a form submission request

PUT /api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid}
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • form_uuid string Required
  • submissionRequest_uuid string Required
application/json

Body

  • description string

    Description of the submission request

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • description string

      The description of the form submission request

    • form object

      The form linked to this submission request

      Hide form attributes Show form attributes object
      • uuid string
      • created_at string
      • updated_at string
      • title string
      • description string
      • live boolean
      • visibility string
      • sections string
      • allowed_hosts array[string]
      • draft_submissions_count integer
      • submitted_submissions_count integer
      • create_client boolean
      • client_type string
    • has_submission boolean

      Denotes if this request has a submission stored against it

    • submission object

      The submission stored against this request

      Hide submission attributes Show submission attributes object
      • uuid string
      • created_at string
      • updated_at string
      • stage string
      • account string
      • request string
      • form string
      • answers array[object]
        Hide answers attributes Show answers attributes object
        • first_name string
        • last_name string
PUT /api/v1/form/{form_uuid}/submission-request/{submissionRequest_uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/form/6ff8f7f6-1eb3-3525-be4a-3932c805afed/submission-request/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"description":"Please can you submit your annual survey form"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "description": "Please can you submit your annual survey form"
}
Response examples (200) 
{
  "form": {
    "live": true,
    "uuid": "1a464eec-2fee-4dc0-9f0c-ab6faf0592c0",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-06-26T11:37:05+01:00",
    "updated_at": "2025-06-26T11:37:05+01:00",
    "visibility": "public",
    "client_type": "client",
    "description": "This is the annual catchup form for 2022",
    "allowed_hosts": [
      "domain.com",
      "subdomain.domain.com"
    ],
    "create_client": true,
    "draft_submissions_count": 5,
    "submitted_submissions_count": 5
  },
  "uuid": "4b862679-5437-470c-86da-ad6618b94c66",
  "created_at": "2025-06-26T11:37:05+01:00",
  "submission": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "ed6ab822-95e3-4637-ad23-6d4df260a2e0",
    "stage": "draft",
    "account": "App\\Http\\Resources\\AccountResource",
    "answers": [
      {
        "last_name": "olive",
        "first_name": "john"
      }
    ],
    "request": "App\\Http\\Resources\\FormSubmissionRequestResource",
    "created_at": "2025-06-26T11:37:05+01:00",
    "updated_at": "2025-06-26T11:37:05+01:00"
  },
  "updated_at": "2025-06-26T11:37:05+01:00",
  "description": "Please submit your annual survey form",
  "has_submission": true
}