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.

Create the service

Get a form

Retrieve a form’s metadata, field schema, and rendered HTML/CSS:
Key fields in the response: The Promise rejects with a 404 error if the form UUID is invalid.

Submit a form

Submitting with file attachments

The maximum total request size is 250 MB.
Each attachment is an object with two fields:

Manage forms

These methods need a forms-scoped API key, sent as Authorization: Bearer YOUR_API_KEY. Create the service with pbMail.formService({ apiKey: 'YOUR_API_KEY' }), or set FORMS_API_KEY in the environment. Without a key they throw an error.

Error handling

The Promise rejects on HTTP 400 (bad request) and 404 (form not found).