PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List forms GETCreate a form POSTGenerate a form definition POSTGet a form GETUpdate a form PATCHDelete a form DELETEList submissions for a form GETSubmit a form as a member POSTGet a form submission GETUpdate a form submission PATCHDelete a form submission DELETE
Forms

Submit a form as a member

Requires `FORMS_SUBMIT` (`FORMS_WRITE` also works). Submits the published form for the member, like a member filling it in: the normal form side effects run (`form.submitted`, workflows, event registration for a linked event). Consent is never recorded through the API: the answers are stored with the submission, but marketing consent, guardian consent and the guardian email are not set on the contact. A member without a primary contact gets one, as for event registration. Callers holding `FORMS_SUBMIT` without `FORMS_READ` (every app caller) can only submit forms with `showInCommunity` on.

POST
/forms/{formId}/submissions

Requires FORMS_SUBMIT (FORMS_WRITE also works). Submits the published form for the member, like a member filling it in: the normal form side effects run (form.submitted, workflows, event registration for a linked event). Consent is never recorded through the API: the answers are stored with the submission, but marketing consent, guardian consent and the guardian email are not set on the contact. A member without a primary contact gets one, as for event registration. Callers holding FORMS_SUBMIT without FORMS_READ (every app caller) can only submit forms with showInCommunity on.

Authorization

x-api-key<token>

In: header

Path Parameters

formId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/forms/string/submissions" \  -H "Content-Type: application/json" \  -d '{    "memberId": "string",    "fields": {      "property1": "string",      "property2": "string"    }  }'
{  "data": {    "id": "string",    "formId": "string",    "source": "HOST",    "fields": {},    "status": "NEW",    "contactId": "string",    "customerId": "string",    "opportunityId": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

List submissions for a form GET

Previous Page

Get a form submission GET

Next Page

memberId*string

Community membership id. The member must be ACTIVE. The submission links to the member's contact (created from their customer record when missing) and customer.

fields*

Answers keyed by field slug (or id), validated against the form's fields definition like a public submission. Send a string for text, email, phone, textarea, hidden, select and radio fields (an option value for the last two), a number for number fields, a boolean for boolean fields and an array of option values for multi_select. Unknown keys are ignored.