Online Form API

Use the following API endpoints to configure advanced settings of your online forms via the API Console.

Notification Email Subject Line

To retrieve the current email subject line for a from, insert the form's ID into the URL and submit a GET request:

To customize the subject line of the notification email, insert the form's ID into the URL and submit a PUT request:

Submit a DELETE request to cancel the customized email subject line and revert to the default one.

Form Prefill

To get the prefill settings of a form, insert the form's ID into the URL and submit a GET request:

To allow or prohibit prepopulated forms that are not signed, insert the form's ID into the URL and submit a PUT request:

Pre-Filled URL

In addition to the generic FormSmarts.com and f8s.co form URLs, FormSmarts members can create pre-filled URLs that include the data needed to pre-populate some of the input fields of an online form. This is useful to pre-fill the ID or email identifying a customer or the amount due on a payment form, as well in many other contexts.

To generate a pre-filled URL for a form, log in to the API Console, paste the API Endpoint listed below after inserting your form's ID into it, and submit a POST request:

Save & Resume

To review the Save & Resume configuration a form, log in to the API Console and submit a GET request with the information below. Replace Form_ID in the API Endpoint with the ID of your form.

To enable Save & Resume and allow users to save a form and continue at a later time, use the API Endpoint URL listed below (after inserting your form's ID into it) and submit a PUT request.

To disable Save & Resume, set enabled = no.

To disable Save & Resume and delete the form's Save & Resume configuration, submit a DELETE request:

Private Form

Private Forms allow FormSmarts members to limit who can to submit a form to invited users within their account.

To check whether a form is private, insert its ID into the API endpoint URL below and submit a GET request:

Forms are public by default. To make a form private, insert its ID into the URL below and submit a PUT request:

To make a Private Form public, insert its ID into the URL below and submit a DELETE request:

Form Confirmation Emails (Auto-Responder)

FormSmarts auto-responder allows you to send an automatic email confirmation when someone submits one of your forms. Note: You can also toggle the autoresponder on and off with the form builder.

To check whether the confirmation email is enabled for a form, insert its ID into the API endpoint URL below and submit a GET request:

To send a confirmation email to the respondent after form submission, insert the ID of the form into the URL below and submit a PUT request:

To disable the email autoresponder and stop sending a copy of the form response to the user, insert the form's ID into the URL below and submit a DELETE request:

Calendar Event

If you add information about an event (date, time, location, organizer info) to a registration form, FormSmarts will attach a calendar event to payment confirmation emails, auto-responder messages, and the email confirmation respondents can request on the Summary page of a form.

To list details of the calendar event associated with a form, insert the form's ID into the URL below and submit a GET request:

To associate an event with a form, insert its ID into the URL below and submit a PUT request:

To remove the event associated with a form, insert the form's ID into the URL below and submit a DELETE request:

Enable/Disable a Form on a Scheduled Date

You can easily enable or disable a form on a scheduled date and time with the form builder.

This API is provided to allow recurring schedules needed to support uses like enable the expenses claim form between noon and 5pm on the last day of each month.

To find out the details of a scheduled form status change, insert its Job ID into the API endpoint URL below and submit a GET request:

To list all scheduled jobs associated with a form and find out their Job ID, replace FORM_ID in the URL below with the form's ID and submit a GET request:

https://formsmarts.com/api/v1/forms/FORM_ID/jobs?event_names=["FormStatusChange"]&types=["cron"]

Submit a POST request to schedule a form status change.

The hour, day, month and day_of_week parameters are concatenated to generate a Cron expression. The syntax and semantics of each parameter are the same as in a standard cron expression.

To cancel the scheduled form enabled/disabled status change, insert the Job ID into the URL below and submit a DELETE request:

Discount Codes

The Discount Code API allows you to manage the discount codes associated with one of your payment forms. This video shows how to use the API.

To list the discount codes associated with an online payment form, insert the ID of the form into the URL (API endpoint) and submit a GET request:

To create a discount code and associate it with a payment form, insert the form's ID into the URL and submit a POST request. You can offer a discount based on a percentage or a flat monetary value.

To delete one or all discount codes associated with a payment form:

1. Insert the ID of the form into the API endpoint
2. Pass the discount code to delete to the code URL parameter, i.e. code=FSPI-The-Discount-Code
3. Submit a DELETE request

Webhooks

The API to register a webhook URL, update it and cancel a webhook is discussed in the webhook documentation:

• Form submission webhook
• Form validation webhook

PayPal Payment Receiver

With PayPal integration, payments are sent by default to the PayPal account matching your FormSmarts login email (which must be the same as the email address designated as Primary in your PayPal account). Some types of FormSmarts accounts also allow you to customize the PayPal payment receiver on a form by form basis.

To check the payment receiver (PayPal account) associated with a form, insert its ID into the API endpoint URL below and submit a GET request:

To update the payment receiver (PayPal account) associated with a form, insert the ID of the form into the URL below and submit a PUT request:

To stop sending payments associated with a form to a customized payment (PayPal) receiver and revert to the PayPal account under your FormSmarts account's login email, insert the form's ID into the URL below and submit a DELETE request:

Stripe Payment Integration

Before you can start accepting Stripe payments with your forms, you must add your Stripe API key to FormSmarts via the API Console:

Submit a GET (read) request to check the status of Stripe integration and make sure your account is ready to accept Stripe payments:

If you no longer want to use the Stripe integration, submit a DELETE request. This will delete the FormSmarts webhook from your Stripe account and remove your Stripe API key from your FormSmarts account.

S/MIME Certificate Addition Request

FormSmarts' secure encrypted email requires that we hold a valid, up-to-date S/MIME certificate for each destination email address of a form.

To add a S/MIME certificate to your account:

1. Submit a Certificate Addition Request (CAR) to the API Endpoint below via the API Console
2. Send a signed message to the long email address like cert+yBf4LjgsqmoOtK0vzJ7sqYLKO2iMNvj-vyEVXE3F2aM@formsmarts.com shown in the response of the Certificate Addition Request

Please make sure the email message is digitally signed with the S/MIME certificate you would like to add to your account.

Create or Reset Your PDF Password

FormSmarts allows members to protect PDF reports with a password. To be able to open password protected documents, please set a PDF password. This password is personal, do not share it. Your PDF password cannot be the same as your FormSmarts password.

To create or change your PDF password:

1. Log in to the API Console
2. Submit a PUT (Update) request as shown below:

If you would like to delete your password from FormSmarts, submit a DELETE request:

Turn On/Off Password Protection of PDF Reports

FormSmarts allows members to protect PDF reports with a password. To be able to open password protected documents, each user has to set a PDF password. The password is personal. It should not be shared with other users and cannot be the same as the user's FormSmarts password.

To turn on/off the password protection of PDF documents:

1. Log in to the API Console
2. Replace Form_ID in the API Endpoint below with the ID of the form. For example, if the URL of a form is https://f8s.co/1234, its ID is 1234.
3. Submit a PUT (Update) request as shown on the screenshot below:

If you would like to check whether PDF reports for a specific form are password protected, submit a GET (Read) request:

Forms Metadata

To get the ID, name, date last used, associated emails, data storage status and URL of each of your online forms, submit a GET request:

Note: the last_used timestamps returned are UTC.

Input Fields

To get a list of the input fields of an online form in the order they appear on the form, and the corresponding pre-fill parameter names, insert the ID of the form into the URL (API endpoint) and submit a GET request:

Form Colors

To check the current buttons and links colors of a from, insert the form's ID into the URL and submit a GET request:

To customize the color of a form's buttons and links, insert the form's ID into the URL and submit a PUT request. Note: You can also change colors directly with the form builder.

Errors

Error 400 - Bad Request

Error 401 - Authentication Failed

Error 403 - Forbidden

Error 404 - Resource Not Found

Error 405 - Method Not Allowed

Error 500 - Internal Server Error

Error 409 - Conflict

Error 503 - Service Not Available

1. Discount code validity dates options are not available with Starter accounts.