v1.0.0

OpenAPI 3.1.0

Form Plume API

Form Plume support

Manage Form Plume forms, submissions, delivery settings, and integrations with an organization API key.

Server

https://api.formplume.com

Production

Client Libraries

Shell Curl

Forms

Create and manage forms and their settings.

Forms Operations

get/v1/forms
post/v1/forms
get/v1/forms/{id}
patch/v1/forms/{id}
delete/v1/forms/{id}

List forms

Returns the forms in your organization, ordered for display in the dashboard and API clients.

Query Parameters

external_key
Type: string

Filter to the form carrying this config-as-code key.

Responses

application/json
application/json
application/json

get/v1/forms

curl https://api.formplume.com/v1/forms \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

[
  {
    "id": "0196f2f6-2ec3-7d91-9ea3-6a63175fc8a1",
    "name": "Contact form",
    "emoji": "📬",
    "public_slug": "contact",
    "access_mode": "public",
    "is_active": true,
    "external_key": "website-contact",
    "created_at": "2026-07-13T18:30:00Z",
    "submission_count": 1,
    "unread_submission_count": 1
  }
]

Forms in the active tenant.

Create form

Creates a form with its public submission endpoint and initial settings.

Body·

required

application/json

name
Type: string
min length:
1
max length:
120
required
access_mode
Type: string enum
values
- public
- protected
emoji
Type: string
min length:
1
max length:
32
external_key
Type: string

Responses

application/json
application/json
application/json
application/json
application/json

post/v1/forms

curl https://api.formplume.com/v1/forms \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Contact form",
  "emoji": "📬",
  "access_mode": "public",
  "external_key": "website-contact"
}'

Show Schema

{
  "id": "0196f2f6-2ec3-7d91-9ea3-6a63175fc8a1",
  "name": "Contact form",
  "emoji": "📬",
  "public_slug": "contact",
  "access_mode": "public",
  "is_active": true,
  "external_key": "website-contact",
  "created_at": "2026-07-13T18:30:00Z",
  "submission_count": 1,
  "unread_submission_count": 1,
  "settings": {
    "response": {
      "success": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      },
      "error": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      }
    },
    "spam": {
      "enabled": true,
      "strictness": "low",
      "blocked_keywords": [
        "viagra"
      ]
    },
    "rate_limit": {
      "disabled": false,
      "limit": 1,
      "window_seconds": 30,
      "burst": 20,
      "burst_window_seconds": 600
    },
    "privacy": {
      "redact_fields": [
        "password"
      ],
      "do_not_store_fields": [
        "credit_card"
      ]
    },
    "email": {
      "notify_spam": false
    },
    "retention": {
      "days": 30
    }
  },
  "notify_emails": [
    "alex@example.com"
  ],
  "notify_cc_emails": [
    "alex@example.com"
  ],
  "notify_bcc_emails": [
    "alex@example.com"
  ],
  "notify_routing_aliases": [
    {
      "alias": "sales",
      "to_emails": [
        "alex@example.com"
      ],
      "cc_emails": [
        "alex@example.com"
      ],
      "bcc_emails": [
        "alex@example.com"
      ]
    }
  ],
  "notify_subject": "New submission on {{form_name}}",
  "allowed_origins": [
    "https://example.com"
  ],
  "updated_at": "2026-07-13T18:35:00Z"
}

Created form.

Get form

Returns one form, including its public slug, status, and configured settings.

Path Parameters

id
Type: string
required

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/forms/{id}

curl 'https://api.formplume.com/v1/forms/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "id": "0196f2f6-2ec3-7d91-9ea3-6a63175fc8a1",
  "name": "Contact form",
  "emoji": "📬",
  "public_slug": "contact",
  "access_mode": "public",
  "is_active": true,
  "external_key": "website-contact",
  "created_at": "2026-07-13T18:30:00Z",
  "submission_count": 1,
  "unread_submission_count": 1,
  "settings": {
    "response": {
      "success": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      },
      "error": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      }
    },
    "spam": {
      "enabled": true,
      "strictness": "low",
      "blocked_keywords": [
        "viagra"
      ]
    },
    "rate_limit": {
      "disabled": false,
      "limit": 1,
      "window_seconds": 30,
      "burst": 20,
      "burst_window_seconds": 600
    },
    "privacy": {
      "redact_fields": [
        "password"
      ],
      "do_not_store_fields": [
        "credit_card"
      ]
    },
    "email": {
      "notify_spam": false
    },
    "retention": {
      "days": 30
    }
  },
  "notify_emails": [
    "alex@example.com"
  ],
  "notify_cc_emails": [
    "alex@example.com"
  ],
  "notify_bcc_emails": [
    "alex@example.com"
  ],
  "notify_routing_aliases": [
    {
      "alias": "sales",
      "to_emails": [
        "alex@example.com"
      ],
      "cc_emails": [
        "alex@example.com"
      ],
      "bcc_emails": [
        "alex@example.com"
      ]
    }
  ],
  "notify_subject": "New submission on {{form_name}}",
  "allowed_origins": [
    "https://example.com"
  ],
  "updated_at": "2026-07-13T18:35:00Z"
}

Form details.

Update form

Updates the supplied settings for a form while leaving omitted settings unchanged.

Path Parameters

id
Type: string
required

Body·

required

application/json

access_mode
Type: string enum
values
- public
- protected
allowed_origins
Type: array string[]
emoji
Type: string
min length:
1
max length:
32
external_key
Type: string
is_active
Type: boolean
name
Type: string
min length:
1
max length:
120
notify_bcc_emails
Type: array string[]
notify_cc_emails
Type: array string[]
notify_emails
Type: array string[]
notify_routing_aliases
Type: array object[] ·
notify_subject
Type: string nullable
settings
Type: object ·

Per-form behavior settings. Send only the sections you want to change; omitted sections keep their stored values. Unknown extra top-level keys are preserved for forward compatibility. CAPTCHA and email hygiene are managed through their dedicated endpoints (/v1/forms/{id}/captcha, /v1/forms/{id}/email-hygiene) and may appear here read-only.

Responses

application/json
application/json
application/json
application/json
application/json

patch/v1/forms/{id}

curl 'https://api.formplume.com/v1/forms/{id}' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Contact form",
  "emoji": "📬",
  "access_mode": "public",
  "is_active": true,
  "settings": {
    "response": {
      "success": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      },
      "error": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      }
    },
    "spam": {
      "enabled": true,
      "strictness": "low",
      "blocked_keywords": [
        "viagra"
      ]
    },
    "rate_limit": {
      "disabled": false,
      "limit": 1,
      "window_seconds": 30,
      "burst": 20,
      "burst_window_seconds": 600
    },
    "privacy": {
      "redact_fields": [
        "password"
      ],
      "do_not_store_fields": [
        "credit_card"
      ]
    },
    "email": {
      "notify_spam": false
    },
    "retention": {
      "days": 30
    }
  },
  "notify_emails": [
    "alex@example.com"
  ],
  "notify_cc_emails": [
    "alex@example.com"
  ],
  "notify_bcc_emails": [
    "alex@example.com"
  ],
  "notify_routing_aliases": [
    {
      "alias": "sales",
      "to_emails": [
        "alex@example.com"
      ],
      "cc_emails": [
        "alex@example.com"
      ],
      "bcc_emails": [
        "alex@example.com"
      ]
    }
  ],
  "notify_subject": "New submission on {{form_name}}",
  "allowed_origins": [
    "https://example.com"
  ],
  "external_key": "website-contact"
}'

Show Schema

{
  "id": "0196f2f6-2ec3-7d91-9ea3-6a63175fc8a1",
  "name": "Contact form",
  "emoji": "📬",
  "public_slug": "contact",
  "access_mode": "public",
  "is_active": true,
  "external_key": "website-contact",
  "created_at": "2026-07-13T18:30:00Z",
  "submission_count": 1,
  "unread_submission_count": 1,
  "settings": {
    "response": {
      "success": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      },
      "error": {
        "type": "hosted_page",
        "redirect_url": "https://example.com/integrations/callback"
      }
    },
    "spam": {
      "enabled": true,
      "strictness": "low",
      "blocked_keywords": [
        "viagra"
      ]
    },
    "rate_limit": {
      "disabled": false,
      "limit": 1,
      "window_seconds": 30,
      "burst": 20,
      "burst_window_seconds": 600
    },
    "privacy": {
      "redact_fields": [
        "password"
      ],
      "do_not_store_fields": [
        "credit_card"
      ]
    },
    "email": {
      "notify_spam": false
    },
    "retention": {
      "days": 30
    }
  },
  "notify_emails": [
    "alex@example.com"
  ],
  "notify_cc_emails": [
    "alex@example.com"
  ],
  "notify_bcc_emails": [
    "alex@example.com"
  ],
  "notify_routing_aliases": [
    {
      "alias": "sales",
      "to_emails": [
        "alex@example.com"
      ],
      "cc_emails": [
        "alex@example.com"
      ],
      "bcc_emails": [
        "alex@example.com"
      ]
    }
  ],
  "notify_subject": "New submission on {{form_name}}",
  "allowed_origins": [
    "https://example.com"
  ],
  "updated_at": "2026-07-13T18:35:00Z"
}

Updated form.

Delete form

Moves a form to trash so it no longer accepts new submissions.

Path Parameters

id
Type: string
required

Responses

204

Form deactivated.
application/json
application/json
application/json
application/json

delete/v1/forms/{id}

curl 'https://api.formplume.com/v1/forms/{id}' \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

No Body

Form deactivated.

Submissions (Collapsed)

Review, update, export, and erase submitted form data.

Submissions Operations

get/v1/forms/{id}/submissions
get/v1/forms/{id}/submissions/{sid}
patch/v1/forms/{id}/submissions/{sid}
delete/v1/forms/{id}/submissions/{sid}
post/v1/forms/{id}/submissions/bulk
get/v1/forms/{id}/submissions/export
get/v1/forms/{id}/data-requests/export
post/v1/forms/{id}/data-requests/erase
get/v1/stats/submissions

Files (Collapsed)

Upload and download files attached to submissions.

Files Operations

post/v1/forms/{id}/uploads/presign
get/v1/submissions/{id}/files/{fileId}/download

Webhooks (Collapsed)

Configure signed webhooks and inspect their deliveries.

Webhooks Operations

get/v1/forms/{id}/webhooks
post/v1/forms/{id}/webhooks
patch/v1/webhooks/{id}
delete/v1/webhooks/{id}
post/v1/webhooks/{id}/secret/rotate
post/v1/webhooks/{id}/test
get/v1/webhooks/{id}/deliveries
post/v1/webhooks/{id}/deliveries/redeliver-failed
get/v1/webhooks/deliveries/{deliveryId}
post/v1/webhooks/deliveries/{deliveryId}/redeliver

Integrations (Collapsed)

Connect forms to external services and manage deliveries.

Integrations Operations

get/v1/forms/{id}/integrations
post/v1/forms/{id}/integrations
patch/v1/integrations/{id}
delete/v1/integrations/{id}
post/v1/integrations/{id}/test
get/v1/integrations/{id}/deliveries
post/v1/integrations/{id}/deliveries/redeliver-failed
get/v1/integrations/deliveries/{deliveryId}
post/v1/integrations/deliveries/{deliveryId}/redeliver

Email (Collapsed)

Configure and test autoresponders and email suppression.

Email Operations

get/v1/forms/{id}/autoresponder
put/v1/forms/{id}/autoresponder
post/v1/forms/{id}/autoresponder/test
get/v1/email/suppression
delete/v1/email/suppression/{id}

Spam protection (Collapsed)

Manage CAPTCHA, email hygiene, and form blocklists.

Spam protection Operations

get/v1/forms/{id}/captcha
put/v1/forms/{id}/captcha
get/v1/forms/{id}/email-hygiene
put/v1/forms/{id}/email-hygiene
get/v1/forms/{id}/blocked-domains
post/v1/forms/{id}/blocked-domains
delete/v1/blocked-domains/{id}
get/v1/forms/{id}/blocked-ips
post/v1/forms/{id}/blocked-ips
delete/v1/blocked-ips/{id}

Analytics & usage (Collapsed)

Inspect form analytics, organization totals, and plan usage.

Analytics & usage Operations

get/v1/forms/{id}/analytics
get/v1/stats/forms
get/v1/usage

Form access keys (Collapsed)

Create and revoke keys for protected form submissions.

Form access keys Operations

get/v1/forms/{id}/keys
post/v1/forms/{id}/keys
post/v1/forms/{id}/keys/{kid}/revoke

API keys (Collapsed)

Inspect the organization API key used for the current request.

API keys Operations

get/v1/api-keys/current

Form Plume API

AuthenticationRequired

Forms

List forms

Create form

Get form

Update form

Delete form

Submissions (Collapsed)

Files (Collapsed)

Webhooks (Collapsed)

Integrations (Collapsed)

Email (Collapsed)

Spam protection (Collapsed)

Analytics & usage (Collapsed)

Form access keys (Collapsed)

API keys (Collapsed)