C# SDK forms client

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

var formsLib = new FormsLibrary();

Use IFormsLibrary for dependency injection in ASP.NET Core:

builder.Services.AddSingleton<IFormsLibrary, FormsLibrary>();

Get a form

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

Form form = formsLib.GetForm("your-form-uuid");

Console.WriteLine("Title: " + form.Title);
Console.WriteLine("HTML: "  + form.FormHtml);

The Form object includes:

Property	Description
`Title`	Display name of the form
`FormJson`	Parsed field schema
`FormHtml`	Rendered HTML for embedding
`FormCss`	Associated stylesheet
`Active`	Whether the form is accepting submissions
`SubmissionCount`	Number of submissions received
`CreatedAt` / `UpdatedAt`	Timestamps

Submit a form

var formData = new Dictionary<string, object>
{
    { "first_name", "Jane" },
    { "last_name",  "Smith" },
    { "email",      "jane@example.com" }
};

formsLib.SubmitForm("your-form-uuid", formData);

SubmitForm returns void on success and throws on failure.

Submitting with file attachments

The maximum total request size is 250 MB.

byte[] fileBytes = File.ReadAllBytes("consent.pdf");

var attachments = new[]
{
    new FormAttachment
    {
        Name    = "consent.pdf",
        Content = Convert.ToBase64String(fileBytes)
    }
};

formsLib.SubmitForm("your-form-uuid", formData, attachments);

The FormAttachment properties:

Property	Description
`Name`	File name including extension
`Content`	Base64-encoded file content

Manage forms

These methods require a FormsLibrary constructed with an API key that has the forms scope, either new FormsLibrary("YOUR_API_KEY") or new FormsLibrary(configuration) with FormsAPIKey set. The key is sent as Authorization: Bearer YOUR_API_KEY. Without a key they throw InvalidOperationException.

Method	Returns
`ListForms(FormsListParams)`	`FormsListResponse`; `CustomerId` is required
`CreateForm(CreateFormRequest)`	`CreateFormResponse`
`GetFormById(formId)`	`Form`
`UpdateForm(formId, UpdateFormRequest)`	`UpdateFormResponse`
`ArchiveForm(formId)` / `UnarchiveForm(formId)`	`string` detail message
`CopyForm(formId, newTitle)`	`Form`
`GetFormStats(customerId)`	`FormStats`; `customerId` is optional
`ListFormSubmissions(formId, SubmissionListParams)`	`FormSubmissionListResponse`
`ExportSubmissionsCsv(formId)`	`string` CSV
`ExportSubmissionCsv(formId, submissionId)`	`string` CSV
`ExportSubmissionPdf(formId, submissionId)`	`byte[]` PDF

var formsAdmin = new FormsLibrary("YOUR_API_KEY");

FormsListResponse list = formsAdmin.ListForms(new FormsListParams
{
    CustomerId = 12345,
    Active = true,
    Page = 1,
    Items = 25
});

foreach (Form f in list.Results)
    Console.WriteLine($"{f.Id}: {f.Title}");

Error handling

Non-2xx responses throw PauboxApiException. Its Message contains only the verb, endpoint, and status; the raw response body is on Body.

try
{
    Form form = formsLib.GetForm("your-form-uuid");
    formsLib.SubmitForm("your-form-uuid", formData);
}
catch (ArgumentException ex)
{
    // Null, empty, or non-UUID formId, or null formData
    Console.WriteLine("Invalid argument: " + ex.Message);
}
catch (PauboxApiException ex)
{
    // API error (404 form not found, 400 bad request, etc.)
    Console.WriteLine($"API error {ex.StatusCode}: {ex.Message}");
}

Get started

Email API

Migrate to Paubox

Marketing API

MCP Server

SDKs

CLI

Forms API

Instantiation

Get a form

Submit a form

Submitting with file attachments

Manage forms

Error handling

​Instantiation

​Get a form

​Submit a form

​Submitting with file attachments

​Manage forms

​Error handling

Instantiation

Get a form

Submit a form

Submitting with file attachments

Manage forms

Error handling