Skip to main content
getForm and submitForm do not require API credentials. The form management methods require an API key with the forms scope (see Manage forms). Forms are identified by a UUID that you obtain from the Paubox dashboard.

Instantiation

No config loading is required for getForm and submitForm.

Get a form

Retrieve a form’s metadata, field schema, and rendered HTML/CSS:
Key Form getters:

Submit a form

submitForm returns void on success (HTTP 201) and throws on failure.

Submitting with file attachments

The maximum total request size is 250 MB.

Manage forms

These methods need a forms-scoped API key, sent as Authorization: Bearer YOUR_API_KEY. Use new FormsService("YOUR_API_KEY"), or set FORMSAPIKEY in config.properties, load it with ConfigurationManager.getProperties, and then call new FormsService(). Without a key they throw an Exception.

Error handling

getForm and submitForm throw Exception on HTTP 400 (bad request) and 404 (form not found).