Create a form

Creates a new form. Returns the UUID of the created form.

POST /api/forms

cURL

basic

curl --request POST \ --url https://api.paubox.com/v1/forms/api/forms \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "title": "Patient Intake Form", "form_json": { "fields": [ { "label": "First name", "type": "text", "required": true } ] }, "customer_id": 123, "version": 1 } '

200

{
  "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

Authorizations

Authorization · string · header · required

Paubox API key sent as Authorization: Bearer YOUR_API_KEY. API keys are created in the Paubox dashboard and must have the "forms" scope; a key without the forms scope receives 401 Unauthorized. A valid key used against a resource that belongs to a different customer receives 403 Forbidden.

Body

application/json

title · string · required

Title of the form

form_json · object · required

The form field schema

customer_id · integer · required

Your Paubox customer ID

version · integer · required

Form schema version

description · string

form_html · string

form_css · string

recipient · string

Comma-separated email addresses notified on each submission.

signable · boolean · default: false

Whether the form collects a signature

signature_confirmation_label · string

subscription_list_id · string

ID of the connected Marketing contact list. For marketing forms, new subscribers are added to this list.

type · string

Form type, for example marketing_form

active · boolean · default: false

submission_count · integer · default: 0

Response

200

application/json

Form created

id · string<uuid>

UUID of the new form