Forms

Create, Update, Delete, and List your Forms.

Form API Actions


ActionMethodPath
CreatePOST/api/v1/forms
UpdatePUT/api/v1/forms/:id
DeleteDELETE/api/v1/forms/:id
ListGET/api/v1/forms

List forms


You can return a list of your forms.

ArgumentOptions
query (string, optional)Filter your forms by name
page (integer, optional)Change the page
Example API call
HTTPS
https://usebasin.com/api/v1/forms?filter_by=All&page=1&query=&api_token={account_api_token}

Make sure you swap out  {account_api_token}  with your account wide API token found on your Account Setting page.

Create/Update a form


The following attributes are available to you.

AttributeType
namestring
redirect_urlstring
use_ajaxboolean
notification_emailsstring Comma seperated list of email addresses used in the "To:" field
notification_cc_emails string Comma seperated list of email addresses used in the "Cc:" field
whitelist_source_domainsstringComma seperated list of domains to whitelist
force_recaptchabooleanIf enabled the g-recaptcha params is required with all your submissions.
notification_subjectstring Subject of the notification email.
notification_from_namestringFrom name for the notification email.
autoreplyboolean Enable the auto response email
autoreply_bodytext Used to populate the body of Basin's default auto response template.
autoreply_subjectstring
autoreply_from_name string
autoreply_greetingstring
autoreply_namestringThe persons name that displays at the bottom of the default auto response email.
autoreply_title stringThe person's title which displays above their name in the default auto response template.
autoreply_email stringThe email that displays at the bottom of the default auto response template
button_background_colorstring (css hex)Override the default Basin themed emails.
button_text_colorstring (css hex)Override the default Basin themed emails.
data_receipt_email boolean Enable the data receipt email.
retention_daysintegerAmount of days to keep submission before deletion (default 1460)
hide_dashboard_buttonboolean Used to disable the "Open in Dashboard" button on the default Basin submission notification emails.
exclude_submitter_from_replyboolean Used to disabled the automatic reply-to email address on Basin's default notification email.
honeypot_fieldstring
recaptcha_failed_urlstring
domain_idintegerThe custom domain id
domain_emailstringThe email for use with the custom domain. Ex: [email protected]
duplicate_filterbooleanEnable to filter duplicate submissions within a brief time window.