Create a submission to a form | PlannrCRM API documentation

Create a submission to a form Run in API Explorer

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)

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
- created_at string
- updated_at string
- stage string
- account object
  
  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
  
  photo_url 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
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  custom_fields string
  
  external_references string
- request object
  
  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
  
  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]
  
  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":"b18d50e3-aed9-41f9-9cf8-649e7fb9fc08"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuid": "b18d50e3-aed9-41f9-9cf8-649e7fb9fc08"
}

Response examples (200)

{
  "form": {
    "live": true,
    "uuid": "62c2b7c3-33af-4fb6-96fb-8213733d5feb",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2026-03-11T10:08:34+00:00",
    "updated_at": "2026-03-11T10:08:34+00: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": "5b91e64c-55be-4446-98ac-2f24a98f0ed5",
  "stage": "draft",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "5938d078-8a99-4ca6-92a1-c9990b676f0d",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-03-11T10:08:34+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-03-11T10:08:34+00:00",
    "with_login": true,
    "inactive_at": "2026-03-11",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-03-11T10:08:34+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-03-11T10:08:34+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-03-11 10:08:34",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-03-11T10:08:34+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-03-11T10:08:34+00:00"
  },
  "answers": [
    {
      "last_name": "olive",
      "first_name": "john"
    }
  ],
  "request": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "ccba6530-571e-408b-8f34-d0e6841c010e",
    "created_at": "2026-03-11T10:08:34+00:00",
    "submission": "App\\Http\\Resources\\FormSubmissionResource",
    "updated_at": "2026-03-11T10:08:34+00:00",
    "description": "Please submit your annual survey form",
    "has_submission": true
  },
  "created_at": "2026-03-11T10:08:34+00:00",
  "updated_at": "2026-03-11T10:08:34+00:00"
}