BangerMail Inc.

BangerMail Inc. Forms API

The Forms API from BangerMail Inc. — 4 operation(s) for forms.

Documentation GitHub OpenAPI

Operations 9

GET /v1/forms/embed.js The signup form loader. #

HEAD /v1/forms/embed.js Read embed script headers #

OPTIONS /v1/forms/embed.js Read public signup CORS policy #

GET /v1/forms/{publicId}/widget A live form's rendered widget (html, css, font link) and popup behavior. #

OPTIONS /v1/forms/{publicId}/widget Read public signup CORS policy #

POST /v1/forms/{publicId}/subscribe A visitor signs up. #

OPTIONS /v1/forms/{publicId}/subscribe Read public signup CORS policy #

POST /v1/forms/{publicId}/view Counts one display of a widget #

OPTIONS /v1/forms/{publicId}/view Read public signup CORS policy #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bangermail-com:bangermail-com-forms-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Banger Forms API
  version: 0.1.0
  description: 'Customer-facing Banger API: workspace resources (mailboxes, sending, threads, contacts, lists, segments, templates, Broadcasts, Journeys, approvals, sending domains, webhooks, API keys) and the public signup-form endpoints. Authenticate workspace requests with `Authorization: Bearer `; create keys in the Banger app under Settings → Developers → Manage API keys. AI agents can use the same capabilities through the Banger MCP server at https://api.bangermail.com/mcp.'
  contact:
    name: Banger support
    email: hello@team.bangermail.com
    url: https://bangermail.com/support/
  termsOfService: https://bangermail.com/terms/
servers:
- url: https://api.bangermail.com
security:
- bearerAuth: []
tags:
- name: Forms
paths:
  /v1/forms/embed.js:
    get:
      operationId: getSignupFormEmbedScript
      summary: The signup form loader.
      security: []
      responses:
        '200':
          description: Embeddable signup form loader.
          content:
            text/javascript:
              schema:
                type: string
      tags:
      - Forms
    head:
      operationId: headSignupFormEmbed
      summary: Read embed script headers
      responses:
        '200':
          description: Successful response.
        default:
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
      tags:
      - Forms
    options:
      operationId: optionsembedjsSignupForm
      summary: Read public signup CORS policy
      responses:
        '204':
          description: Successful response.
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                const: '*'
            Access-Control-Allow-Methods:
              schema:
                type: string
                const: GET, POST
            Access-Control-Max-Age:
              schema:
                type: string
                const: '86400'
            Access-Control-Allow-Headers:
              schema:
                type: string
                const: content-type
        default:
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
      tags:
      - Forms
  /v1/forms/{publicId}/widget:
    parameters:
    - name: publicId
      in: path
      required: true
      schema:
        type: string
        pattern: ^f_[a-z0-9]{16}$
    get:
      operationId: getSignupFormWidget
      summary: A live form's rendered widget (html, css, font link) and popup behavior.
      security: []
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: object
                    required:
                    - kind
                    - lang
                    - html
                    - css
                    - font_href
                    - redirect_url
                    - behavior
                    properties:
                      kind:
                        type: string
                        enum:
                        - inline
                        - popup
                        - bar
                        - slide_in
                        - page
                      lang:
                        type: string
                      html:
                        type: string
                      css:
                        type: string
                      font_href:
                        type: string
                      redirect_url:
                        type: string
                      behavior:
                        type: object
                        required:
                        - delay_seconds
                        - scroll_percent
                        - exit_intent
                        - frequency_days
                        properties:
                          delay_seconds:
                            type: number
                          scroll_percent:
                            type: number
                          exit_intent:
                            type: boolean
                          frequency_days:
                            type: number
        '404':
          description: The form does not exist or is paused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Forms
    options:
      operationId: optionswidgetSignupForm
      summary: Read public signup CORS policy
      parameters:
      - name: publicId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successful response.
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                const: '*'
            Access-Control-Allow-Methods:
              schema:
                type: string
                const: GET, POST
            Access-Control-Max-Age:
              schema:
                type: string
                const: '86400'
            Access-Control-Allow-Headers:
              schema:
                type: string
                const: content-type
        default:
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
      tags:
      - Forms
  /v1/forms/{publicId}/subscribe:
    parameters:
    - name: publicId
      in: path
      required: true
      schema:
        type: string
        pattern: ^f_[a-z0-9]{16}$
    post:
      operationId: submitSignupForm
      summary: A visitor signs up.
      security: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  format: email
                  maxLength: 320
                name:
                  type: string
                  maxLength: 100
                page:
                  type: string
                  maxLength: 2000
                elapsed:
                  type:
                  - number
                  - string
                  description: Milliseconds elapsed since displaying the form.
                lang:
                  type: string
                  maxLength: 35
                locale:
                  type: string
                  maxLength: 35
                website:
                  type: string
                  maxLength: 200
                  description: Honeypot; leave empty.
              additionalProperties:
                type:
                - string
                - number
              description: Custom answers use x_<field key> (or the unprefixed key). Required answers depend on the form configuration. The handler reads the first 8000 characters of the body.
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  format: email
                  maxLength: 320
                name:
                  type: string
                  maxLength: 100
                page:
                  type: string
                  maxLength: 2000
                elapsed:
                  type:
                  - number
                  - string
                  description: Milliseconds elapsed since displaying the form.
                lang:
                  type: string
                  maxLength: 35
                locale:
                  type: string
                  maxLength: 35
                website:
                  type: string
                  maxLength: 200
                  description: Honeypot; leave empty.
              additionalProperties:
                type:
                - string
                - number
              description: Custom answers use x_<field key> (or the unprefixed key). Required answers depend on the form configuration. The handler reads the first 8000 characters of the body.
      responses:
        '200':
          description: Signup accepted.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - status
                properties:
                  ok:
                    type: boolean
                    const: true
                  status:
                    type: string
                    enum:
                    - pending_confirmation
                    - subscribed
                    - already_subscribed
                  redirect_url:
                    type: string
        default:
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Forms
    options:
      operationId: optionssubscribeSignupForm
      summary: Read public signup CORS policy
      parameters:
      - name: publicId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successful response.
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                const: '*'
            Access-Control-Allow-Methods:
              schema:
                type: string
                const: GET, POST
            Access-Control-Max-Age:
              schema:
                type: string
                const: '86400'
            Access-Control-Allow-Headers:
              schema:
                type: string
                const: content-type
        default:
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
      tags:
      - Forms
  /v1/forms/{publicId}/view:
    parameters:
    - name: publicId
      in: path
      required: true
      schema:
        type: string
        pattern: ^f_[a-z0-9]{16}$
    post:
      operationId: recordSignupFormView
      summary: Counts one display of a widget
      security: []
      responses:
        '204':
          description: Counted.
      tags:
      - Forms
    options:
      operationId: optionsviewSignupForm
      summary: Read public signup CORS policy
      parameters:
      - name: publicId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successful response.
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                const: '*'
            Access-Control-Allow-Methods:
              schema:
                type: string
                const: GET, POST
            Access-Control-Max-Age:
              schema:
                type: string
                const: '86400'
            Access-Control-Allow-Headers:
              schema:
                type: string
                const: content-type
        default:
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
      tags:
      - Forms
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
            details:
              type: object
              additionalProperties: true
              description: Machine-readable context. A send refused by sender-reputation enforcement (423 sending_lane_paused, sending_domain_paused, sending_mailbox_paused, sending_workspace_frozen) carries scope, reason, hold_id, paused_at, review_required and resumable_after.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or bgr_ workspace API key
externalDocs:
  description: Banger API reference
  url: https://bangermail.com/docs/api/