Create a submission to a form

POST /api/v1/form/{form_uuid}/submission
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • form_uuid string Required
application/json

Body

  • account_uuid string

    UUID of the account to attach the form submission to, if left blank will use the authenticated account

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.

    • stage string

      The stage of the submission

    • account object

      Account responsible for answering the form

      Hide account attributes Show account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
    • request object

      Form submission request attached to this submission if it has one

      Hide request attributes Show request attributes object
      • uuid string
      • created_at string
      • updated_at string
      • description string
      • form string
      • has_submission boolean
      • submission string
    • form object

      The form that this submission was created for

      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
    • answers array[object]

      The answers to the questions

      Hide answers attributes Show answers attributes object
      • first_name string
      • last_name string
POST /api/v1/form/{form_uuid}/submission 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/form/6ff8f7f6-1eb3-3525-be4a-3932c805afed/submission' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuid":"bf6eac4b-f9dc-48e9-a001-47e3ce676b53"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuid": "bf6eac4b-f9dc-48e9-a001-47e3ce676b53"
}
Response examples (200) 
{
  "form": {
    "live": true,
    "uuid": "58fa8612-8c93-43af-8a4d-cbae32d40b5e",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-07-14T14:20:17+01:00",
    "updated_at": "2025-07-14T14:20:17+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": "bbf96acd-3c45-4f5c-8f5f-993c0f271dcb",
  "stage": "draft",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "132fea4a-a88c-4633-8240-c19dfb726867",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-07-14T14:20:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-07-14T14:20:17+01:00",
    "with_login": true,
    "inactive_at": "2025-07-14",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-07-14T14:20:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-07-14T14:20:17+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-07-14T14:20:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-07-14T14:20:17+01:00"
  },
  "answers": [
    {
      "last_name": "olive",
      "first_name": "john"
    }
  ],
  "request": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "84f58974-78ec-491a-b0d0-e5603e59cc8b",
    "created_at": "2025-07-14T14:20:17+01:00",
    "submission": "App\\Http\\Resources\\FormSubmissionResource",
    "updated_at": "2025-07-14T14:20:17+01:00",
    "description": "Please submit your annual survey form",
    "has_submission": true
  },
  "created_at": "2025-07-14T14:20:17+01:00",
  "updated_at": "2025-07-14T14:20:17+01:00"
}