POST https://api.usecommune.com/newsletters/{newsletter}/forms Production. There is no separate sandbox host.

Create a signup form

Makes a signup form for this newsletter's list. Needs audience: write, and is a write. Only for a newsletter Commune sends: anything else answers 422.

Only name is required, and it is the form's name in Commune, which readers never see. Everything left out takes the default a new form gets in Commune: a heading naming the newsletter, Subscribe on the button, no name field, a message after signing up and Commune's thank-you page after confirming.

Making a form subscribes nobody. Somebody who signs up through it gets an email asking them to confirm, and joins the list only once they click it; somebody already on the list joins the form straight away, with no email from it. Either way they get tag_ids and the newsletter publishes subscriber.joined_form, which an automation can start on. No request through this API can put anybody on the list through a form: only the reader can.

confirmation_email is the email that asks a new signup to confirm: its subject, the text above the button, the button's label and colour and the small print under it. Every setting left null falls back to the newsletter's default (PATCH /newsletters/{newsletter}/form-defaults) and from there to Commune's own email, so a form that sets none of them sends what every form does. The confirm button is always in it.

embed in the response is the code to paste. The script renders the form with the settings saved here and picks up later changes by itself.

Publishes no event.

Path parameters

  • string Required

Request Headers

  • string Required
  • string

Body

  • string Required
  • string
  • string
  • string
  • string
  • object
  • object
  • array[string(uuid)]
  • object
  • object
  • object
POST /newsletters/{newsletter}/forms
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-createform

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.