Skip to main content
get_form and submit_form do not require API credentials. Forms are identified by a UUID that you obtain from the Paubox dashboard. The SDK checks the format and raises ArgumentError for a form ID that is not a UUID, before sending a request. The form management methods require a scoped API key; see Manage forms.

Instantiation

Get a form

Retrieve a form’s metadata, field schema, and rendered HTML/CSS:
The returned Paubox::Form object exposes:

Submit a form

Submitting with file attachments

The maximum total request size is 250 MB.

Manage forms

The management methods require a scoped API key with the forms scope, passed as api_key: or set with config.forms_api_key. It can be the same key as the Email API key if that key also has the forms scope.
Available methods: find_form, list_forms (requires customer_id:), create_form, update_form, archive_form, unarchive_form, copy_form, form_stats, list_submissions, submissions_csv, and submission_pdf. Calling one without a key raises ArgumentError.

Error handling

A non-2xx response raises Paubox::FormsClient::Error, which provides status_code, url, and response_body: