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
      • 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":"d76210b4-fe60-40e8-a463-f3b90defe6dc"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuid": "d76210b4-fe60-40e8-a463-f3b90defe6dc"
}
Response examples (200) 
[
  {
    "form": {
      "live": true,
      "uuid": "e4c2c822-e8fd-42e5-a653-ee44b2bb5ff9",
      "title": "Annual Catchup 2022",
      "sections": "App\\Http\\Resources\\FormQuestionResource",
      "created_at": "2025-12-12T16:22:25+00:00",
      "updated_at": "2025-12-12T16:22:25+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": "e04ff100-e18b-4804-94a0-66af494e5e7a",
    "stage": "draft",
    "account": {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "16ae7d62-ac1c-477a-9dd5-e4b17a104f57",
      "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": "2025-12-12T16:22:25+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-12-12T16:22:25+00:00",
      "with_login": true,
      "inactive_at": "2025-12-12",
      "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-12-12T16:22:25+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-12-12T16:22:25+00: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-12-12T16:22:25+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-12-12T16:22:25+00:00"
    },
    "answers": [
      {
        "last_name": "olive",
        "first_name": "john"
      }
    ],
    "request": {
      "form": "App\\Http\\Resources\\FormResource",
      "uuid": "e3036746-608b-424c-909c-b06b5d7dd224",
      "created_at": "2025-12-12T16:22:25+00:00",
      "submission": "App\\Http\\Resources\\FormSubmissionResource",
      "updated_at": "2025-12-12T16:22:25+00:00",
      "description": "Please submit your annual survey form",
      "has_submission": true
    },
    "created_at": "2025-12-12T16:22:25+00:00",
    "updated_at": "2025-12-12T16:22:25+00:00"
  }
]