Store a submission request

POST /api/v1/form/{form_uuid}/submission-request/{account_uuid}

Headers

Path parameters

application/json

Body

Responses

  • 201 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

    • has_submission boolean

      Denotes if this request has a submission stored against it

    • submission object

      The submission stored against this request
POST /api/v1/form/{form_uuid}/submission-request/{account_uuid} 
curl \
 -X POST https://api.plannrcrm.com/api/v1/form/form_uuid/submission-request/account_uuid \
 -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 '{"description":"Please can you submit your annual survey form"}'
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
{
  "description": "Please can you submit your annual survey form"
}
Response examples (201) 
{
  "form": {
    "live": true,
    "uuid": "1dd25912-db3c-4af7-97bc-55dc6286139e",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2024-10-16T11:10:14+01:00",
    "updated_at": "2024-10-16T11:10:14+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": "8b36150b-a931-4f50-906c-b284616d741d",
  "created_at": "2024-10-16T11:10:14+01:00",
  "submission": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "5bcd7b9b-17fa-4393-b543-3b90d7044cd4",
    "stage": "draft",
    "account": "App\\Http\\Resources\\AccountResource",
    "answers": [
      {
        "last_name": "olive",
        "first_name": "john"
      }
    ],
    "request": "App\\Http\\Resources\\FormSubmissionRequestResource",
    "created_at": "2024-10-16T11:10:14+01:00",
    "updated_at": "2024-10-16T11:10:14+01:00"
  },
  "updated_at": "2024-10-16T11:10:14+01:00",
  "description": "Please submit your annual survey form",
  "has_submission": true
}