Click the button to confirm your subscription.
" } }, { "type": "button", "props": { "label": "Confirm", "href": "{{ confirmation_url }}" } }, { "type": "footer", "props": { "company": "Acme Inc.", "address": "1 Main Street, Springfield", "showUnsubscribe": false } } ] } } } ``` You do not need `html_body_add_footer`. If you send `false`, Broadcast changes it to `true` and the response carries a `parameter_overridden` warning. This does not add the link to the confirmation. The send controls the link, in step 2. **Step 2.** Create the subscriber with double opt-in, and turn the link off: ```http POST /api/v1/subscribers { "subscriber": { "email": "jane@example.com", "first_name": "Jane" }, "double_opt_in": { "confirmation_template_id": 456, "include_unsubscribe_link": false } } ``` The subscriber stays unconfirmed until they click the link. Without `confirmation_template_id`, Broadcast sends the channel's default confirmation template. See [Subscribers API](https://sendbroadcast.net/docs/api-subscribers#create-subscriber-with-double-opt-in). ## Double opt-in with your own email content Use this recipe when you want to write the confirmation email in the request, with no template. The transactional API sends it with no unsubscribe link by default. ```http POST /api/v1/transactionals { "to": "jane@example.com", "subject": "Please confirm your subscription", "body": "Hi {{ first_name }}, please confirm your subscription.
", "double_opt_in": true, "subscriber": { "first_name": "Jane" } } ``` Broadcast creates the subscriber if it does not exist. See [Transactional Email API](https://sendbroadcast.net/docs/api-transactional-email#double-opt-in-via-transactional-email). ## A receipt or password reset Use this recipe for an email that a person needs, whether or not they subscribe to your marketing. Transactional emails have no unsubscribe link by default. ```http POST /api/v1/transactionals { "to": "jane@example.com", "template_id": 789, "subject": "Your receipt for order 1001" } ``` The template gives the body. `subject` replaces the template's subject. Leave out `template_id` and send `subject` and `body` to write the email in the request. ## A welcome sequence after confirmation Use this recipe to send a series of emails after someone confirms. Sequence emails are marketing, so keep the unsubscribe link on. **Step 1.** Add a `send_email` step to the sequence: ```http POST /api/v1/sequences/12/steps { "sequence_step": { "action": "send_email", "label": "Welcome", "parent_id": 1, "subject": "Welcome to Acme", "body": "Hi {{ subscriber.first_name }}, thanks for joining.", "include_unsubscribe_link": true } } ``` **Step 2.** Enroll subscribers. For an opt-in form, set the form's sequences. A subscriber is enrolled after they sign up, or after they confirm when double opt-in is on. Only active sequences enroll subscribers: ```http PATCH /api/v1/opt_in_forms/123 { "opt_in_form": { "automation_settings": { "sequence_ids": [12] } } } ``` To enroll one subscriber directly: ```http POST /api/v1/sequences/12/add_subscriber { "subscriber": { "email": "jane@example.com", "first_name": "Jane" } } ``` See [Sequences API](https://sendbroadcast.net/docs/api-sequences). ## A newsletter to a segment Use this recipe to send one email to many subscribers. A broadcast always has an unsubscribe link. A footer block with **Show unsubscribe link** on gives it your design. With no footer block, Broadcast adds the channel footer. **Step 1.** Create the broadcast: ```http POST /api/v1/broadcasts { "broadcast": { "subject": "October news", "content_type": "blocks", "segment_ids": [34], "blocks_json": { "version": 1, "blocks": [ { "type": "heading", "props": { "text": "October news" } }, { "type": "text", "props": { "html": "Here is what changed this month.
" } }, { "type": "footer", "props": { "company": "Acme Inc.", "address": "1 Main Street, Springfield" } } ] } } } ``` **Step 2.** Send it now, or schedule it: ```http POST /api/v1/broadcasts/321/schedule_broadcast { "broadcast": { "scheduled_send_at": "2026-11-03 09:00", "scheduled_timezone": "America/New_York" } } ``` To send it now, use `POST /api/v1/broadcasts/321/send_broadcast`. See [Broadcasts API](https://sendbroadcast.net/docs/api-broadcasts). ## Move subscribers from another platform Use this recipe to import a list without sending a confirmation to people who already confirmed. People who already confirmed: send `confirmed_at`. This needs an admin API token. A channel token ignores the field and returns a warning. ```http POST /api/v1/subscribers?broadcast_channel_id=1 { "subscriber": { "email": "jane@example.com", "confirmed_at": "2024-06-01T10:00:00Z" } } ``` People who unsubscribed: send `unsubscribed_at`. Any API token can do this. Broadcast stores them as unsubscribed in the same request, and sends them nothing. ```http POST /api/v1/subscribers { "subscriber": { "email": "sam@example.com", "unsubscribed_at": "2025-03-14T09:30:00Z" } } ``` See [Subscribers API](https://sendbroadcast.net/docs/api-subscribers#migrating-already-confirmed-subscribers-admin-api-tokens-only). ## Read the warnings A response can carry warnings when Broadcast ignores or changes a value you sent. Read them while you build an integration. See [API Response Warnings](https://sendbroadcast.net/docs/api-response-warnings), and [API Response Warnings](https://sendbroadcast.net/docs/api-response-warnings#emails-sent-with-the-unsubscribe-link-off) for the unsubscribe link.