Create a submission to a form

POST /api/v1/form/{form_uuid}/submission

Headers

Path parameters

form_uuid integer 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
  
  Additional properties are allowed.
- request object
  
  Form submission request attached to this submission if it has one
  
  Additional properties are allowed.
- form object
  
  The form that this submission was created for
  
  Additional properties are allowed.
- answers array[object]
  
  The answers to the questions
  
  Additional properties are allowed.

POST /api/v1/form/{form_uuid}/submission

curl \
 -X POST https://api.plannrcrm.com/api/v1/form/form_uuid/submission \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"account_uuid":"4adbaa42-1d41-401b-b91b-626a1762673e"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuid": "4adbaa42-1d41-401b-b91b-626a1762673e"
}

Response examples (200)

{
  "form": {
    "live": true,
    "uuid": "9e787f92-83c8-4c9e-8423-f6fa36c961b0",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2024-11-20T13:24:01+00:00",
    "updated_at": "2024-11-20T13:24:01+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": "97e0bfba-3177-4516-b626-4c79091d8591",
  "stage": "draft",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "05f6e491-b5e7-4947-958b-644c972825bf",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:01+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:01+00:00",
    "with_login": true,
    "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": "2024-11-20T13:24:01+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:01+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:01+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:01+00:00"
  },
  "answers": [
    {
      "last_name": "olive",
      "first_name": "john"
    }
  ],
  "request": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "65c923bd-b1b3-4824-a70c-31f1b695f522",
    "created_at": "2024-11-20T13:24:01+00:00",
    "submission": "App\\Http\\Resources\\FormSubmissionResource",
    "updated_at": "2024-11-20T13:24:01+00:00",
    "description": "Please submit your annual survey form",
    "has_submission": true
  },
  "created_at": "2024-11-20T13:24:01+00:00",
  "updated_at": "2024-11-20T13:24:01+00:00"
}