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

Update a form submission

Patch stored answers, status, or CRM links. Merged answers are validated against the form definition. Does not re-run form.submitted side effects. Pass null on a link id to unlink. Contact and opportunity records stay.

PATCH
/form-submissions/{submissionId}

Patch stored answers, status, or CRM links. Merged answers are validated against the form definition. Does not re-run form.submitted side effects. Pass null on a link id to unlink. Contact and opportunity records stay.

Authorization

x-api-key<token>

In: header

Path Parameters

submissionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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

Get a form submission GET

Previous Page

Delete a form submission DELETE

Stored answers are removed. The contact and opportunity stay.

fields?

Merged into stored answers, then validated.

status?string

Value in

  • "NEW"
  • "SPAM"
contactId?string
customerId?string
opportunityId?string