WebForms

Submit a web form

Submits data to an Aptly Web Form. The request must use the API key issued for this exact form and that key must have insert access to the form's board.

Submitted board-field values are keyed by field UUID. Depending on the form's configuration, the submission creates a card or updates a card whose configured match fields have the same values. Unknown properties are ignored. Contact shortcut properties can link the card to an existing contact or create a new contact when the form and board allow it.

post/api/web-forms/{formId}

Request

Path parameters

formIdstring required

Web Form ID.

Request body

namestring

Card name. Takes precedence over title.

titlestring

Card name when name is omitted.

contactFirstNamestring

Contact first name used by automatic contact linking.

contactLastNamestring

Contact last name used by automatic contact linking.

contactFullNamestring

Contact full name used by automatic contact linking.

contactEmailstring email

Contact email used for lookup or creation.

contactPhonestring

Contact phone number used for lookup or creation.

Response

Submission accepted and its card created or updated.

Changes

No recorded changes to this operation across all 1 revision of this API.