Email marketing workspaces with SendBeam: contacts, lists, tags, campaigns, automations and transactional email.
Explore 136 workflow actions for SendBeam, including account permissions and operation limits.
55 read actions81 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
A contact's activity
Read
Everything that has happened to the contact, newest first, 25 a page: email sent (campaign, automation, transactional, notification, with status), open, click (the URL in detail), enrolled (an.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A digest's last 10 runs
Read
A digest's last 10 runs
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A form's submissions
Read
What people sent through the form, newest first.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A/B test state and live counts
Read
The test settings and state stored on the campaign, what it varies (teston), each version (versions[]: letter, label, and the subject, fromname, or sendoffsetminutes + releaseat it tests) and live.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Activate an automation
Write
Runs the pre-flight checks and, if they pass, sets the automation to active so new trigger events enrol contacts.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add a contact to a list
Write
Adds an existing subscribed contact to the list.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add a feed
Write
Watches an RSS 2.0 or Atom feed and sends new posts to the audience as a campaign.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add a sending domain
Write
Adds a domain to send from, the same as Settings → Sending: publish the CNAME records returned in records, then call verify (SendBeam also re-checks on its own).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add a tag to a contact
Write
Attaches a tag to the contact , by tagid, or by name (matched case-insensitively; a tag that does not exist yet is created) , and enrols the contact in active tagadded automations whose.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add or replace a topic digest's sections
Write
Adds or replaces up to 500 sections per request (a topic already uploaded is replaced, matched case-insensitively; within one request the last occurrence wins).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Apply a blueprint into a workspace
Write
Materialises the blueprint into tenantid: custom fields are created (a key already declared there is left alone and reported as skipped, never overwritten), each captured automation is imported as a.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive a list
Write
Archives a list: it keeps its members, history and reporting, is left out of GET /lists and every picker, and takes no new members (adding someone is refused with 409).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Browse the suppression list
Read
A page of the suppression list, newest first.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Bulk action on contacts
Write
Runs one action over a set of contact IDs: unsubscribe, archive, restore, delete, erase, addtag, removetag, addtolist, removefromlist or export.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel a scheduled campaign, or stop one that is sending
Write
Moves a scheduled campaign to cancelled so it will not be sent.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change a digest
Write
A partial update; only the fields sent change.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change the brand kit
Write
Merges the fields sent over the current kit: send only colors and the logo stays.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change the sending defaults
Write
Changes the default pace, the workspace's hourly cap and the link-tagging default.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Check a sending domain now
Write
Checks the domain's DNS records now (the Check button under Settings → Sending) and returns each record's verdict.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Compile MJML without saving
Read
What the block editor shows while you type: the compiled fragment and head, the slots the markup declares, and document, a whole email with the slots filled from values (or their defaults) for a.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Create a campaign
Write
Creates a draft campaign.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a contact
Write
Creates a subscribed contact.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a custom block
Write
Compiles the MJML once and stores the block.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a custom field
Write
Declares a field.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a digest
Write
A new digest for the signed-in person.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a draft automation from a recipe
Write
Materialises the recipe into a draft automation (never active) with its starter copy, resolving each placeholder by the choice given: { existing: <id or key } uses something the workspace already.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a form
Write
Creates an active form.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a list
Write
Creates a list.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a segment
Write
Saves a named rule set.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a tag
Write
Creates a tag.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a template
Write
Creates a template.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create an automation
Write
Creates an automation in draft status with its steps.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a blueprint
Write
Removes the blueprint from the account.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a contact
Write
Permanently deletes a contact and its tag and list memberships.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a custom block
Write
Removes the block from the library.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a custom field
Write
Removes the field and its value from every contact in the workspace, and takes it off every signup form that collected it.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a digest
Write
Delete a digest
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a draft or cancelled campaign
Write
Removes a campaign that never went out.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a feed
Write
Campaigns already sent from it are kept (their rssfeedid becomes null).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a form
Write
Deletes the form identified by id in the body.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a list
Write
Deletes the list and its memberships.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a segment
Write
Deletes the segment.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a tag
Write
Deletes the tag and removes it from every contact.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a template
Write
Deletes the template.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete an automation
Write
Deletes the automation together with its steps and every enrolment (active or finished).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Duplicate a campaign
Write
Creates a new draft copying the content and audience of an existing campaign.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
End an A/B test now
Write
Settles a running test straight away: with {"winner": "a" | "b" | … } that version goes to the remaining recipients (it must be one of the versions the test sent); with no body the version with the.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch the feed and render the email
Write
Fetches the feed now and returns what a send would contain , the new items (or, when nothing is new, the newest ones as a sample), the subject and the rendered HTML.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a campaign
Read
Returns one campaign with a stats object computed from its per-recipient send records.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a contact
Read
Returns one contact including its tags.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a custom block
Read
One block, source and compiled output.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a feed and its recent campaigns
Read
Get a feed and its recent campaigns
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a form
Read
One form by id, with its views, submissions and conversionrate.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a list
Read
Returns one list with its member count.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a segment
Read
Returns one segment with the same live contactcount and reachablecount the list endpoint computes.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a sending domain
Read
One sending domain with its state and records.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a tag
Read
Returns one tag with contactcount, the number of contacts carrying it.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get a template
Read
Returns one template.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get an automation
Read
Returns one automation with its steps in order.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Get one recipe
Read
One recipe with its outline and placeholders , what a POST here will ask about.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
How the workspace's email did
Read
The Reports page's numbers for a period, from the same calculation, so the page and the API always agree.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Import contacts from CSV
Write
Creates contacts from a UTF-8 CSV with an email column (5 MB at most, roughly 50,000 rows); other recognised columns are first_name, last_name, status, tags, subscribed_at, unsubscribed_at, source and the consent columns, and any other column becomes a custom field. Opt-out rows go on the suppression list, pending rows are never imported, and no automation runs unless run_automations is on.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Import suppressions (JSON or CSV)
Write
Puts addresses on the workspace's suppression list so they are never emailed.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Is the store connected, and what has it sold
Read
Whether a Shopify store is connected (the signing secret is never returned; it is set in the app under Settings → E-commerce), orders over the last 30 days with revenue per currency net of refunds.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Is the workspace's email getting through
Read
One read for "is my email reaching people?": the sender the workspace sends as and whether it may (sender.allowed, with the problem when not); whether sending is paused, in the same words the app.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Lift the block a deleted contact left
Write
Takes a deleted suppression off the list so the address can be re-added by an import, the API or a signup form.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Links clicked, email clients and poll answers
Read
For a topic digest, topics breaks the send down per topic.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List a contact's tags
Read
Returns the tags attached to a contact with the time each was assigned.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List a data-fed campaign's runs
Read
The runs made from this campaign, newest first (up to 50), each with its status and headline stats.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List a topic digest's sections
Read
The sections uploaded to a topic digest (see DigestSettings), by position then topic, page by page.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List audit events
Read
Who did what in the workspace, newest first: sign-ins and sign-outs, two-factor and passkey changes, API keys created and revoked, team changes, sender and domain changes, webhooks, connections,.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List automation recipes
Read
The gallery behind "New automation": ready-made automations (welcome series, tag hand-off, birthday, renewal reminder, re-engagement, post-purchase, form → sales, signup anniversary), each with its.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List automations
Read
Returns automations, newest first, without their steps.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List campaigns
Read
Returns campaigns, newest first, with pagination.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List contacts
Read
Returns the workspace's contacts, newest first by default, with pagination.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List custom blocks
Read
The workspace's own email blocks, by name.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List custom fields
Read
Every custom field declared in the workspace, in display order, with how many contacts carry each key (uses, null when usage counts are unavailable).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List feeds
Read
List feeds
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List forms
Read
Returns every form in the workspace, newest first, each with its views, submissions and conversionrate (see the Form schema).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List hosted images
Read
Every image the workspace has uploaded, newest first, with the storage used and the plan's cap.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List lists
Read
Returns the lists in the workspace, newest first.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List members of a list
Read
Returns the contacts in a list, most recently added first, with pagination.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List recent events
Read
The most recent events of one type in the workspace, newest first, each exactly the JSON body a webhook endpoint received for it , so an integration can show real data, for example in a test step,.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List segments
Read
Returns every segment, newest first, each with a live contactcount (raw rule match) and reachablecount (the subscribed subset a campaign could actually reach).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List sending domains
Read
The workspace's sending domains: each one's state (pending, recordsready, verifying, verified, failed) and the DNS records to publish, with whether the last check found each.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List tags
Read
Returns all tags in the workspace sorted by name.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List templates
Read
Returns templates, newest first, optionally filtered by category.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
List the account's blueprints
Read
Every blueprint saved on this login's account, newest first, with counts of what each one captured.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
One of your digests
Read
With version (also the ETag) for If-Match, and nextat.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Pause a campaign that is sending
Write
Holds a sending campaign: it moves to paused and nothing more goes out (within a minute).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Pause an automation
Write
Sets the automation to paused; no new enrolments happen and pending steps stop advancing.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Preview a campaign's audience
Read
Returns how many contacts the campaign would reach if it were sent now, computed by exactly the resolver the send endpoint and the scheduler use: subscribed contacts only; on a double opt-in list.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Preview a saved segment
Read
Counts the contacts matching a saved segment and returns up to 5 sample contacts.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Preview an audience before saving a campaign
Read
The same answer as GET /api/v1/campaigns/{id}/audience for an audience that is not saved yet: send sendtotype (all, list or segment) and, for a list or segment, its sendtoid.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Preview rules before saving
Read
Counts the contacts matching an ad-hoc rule set and returns up to 5 sample contacts.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Register keys already in use
Write
Scans the workspace's contacts for keys that have no field yet and declares each one.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove a contact from a list
Write
Removes the contact from the list.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove a hosted image
Write
Deletes the file.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove a sending domain
Write
Removes the domain; mail can no longer be sent from it.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove a tag from a contact
Write
Detaches the tag from the contact.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove sections from a topic digest
Write
Removes the named topics ({"topics": ["Area: AL1"]}, up to 500, case-insensitive), or every topic with ?all=true.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Render an email for one contact
Read
Resolves the merge tags in subject, html and text exactly as a send would, for the contact named by contactid (one of this workspace's) or, without one, for a stand-in built from the signed-in.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Report a cart, product-view, order, refund or cancellation event
Write
Feeds the three native e-commerce automation triggers (cartabandoned, productviewed, orderplaced , see TriggerType): matches or creates the contact by email using the same rules as every other.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Request, give or refuse approval for a campaign
Write
Workspaces can require a reviewer's approval before a campaign sends or is scheduled (Settings → Sending).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resume a paused campaign
Write
Moves a paused campaign back to sending.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Revoke the report link
Write
Revoke the report link
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run a data-fed campaign
Write
A data-fed campaign is designed in SendBeam , content, subject, sender and audience , and its figures arrive here on each run: a weekly report, a new-listings round-up.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Save the current workspace as a blueprint
Write
Captures the AUTHENTICATED workspace's custom-field definitions, its automations (each turned back into the same recipe shape POST /api/v1/automation-recipes/{slug} resolves, so applying one goes.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a single email to a contact
Write
Sends one transactional email to a contact from the workspace's sender identity (re-validated on every send: the workspace's own shared address or a domain it has verified).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a test copy
Write
Sends the campaign as a test , to the signed-in person by default, or to to (a list of addresses, or one comma-separated string), each copy with [Test] in front of the subject, the same From, merge.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send confirmation emails to pending members
Write
Sends (or re-sends) the double opt-in confirmation email to members of the list who have not confirmed yet , the deliberate counterpart of a bulk add or an import, which never send one.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send now
Write
Sends the posts that are new since the last send as a campaign.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send or schedule a campaign
Write
With a scheduledat in the future the campaign becomes scheduled and is sent by the scheduler at that time (200).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send site email to any address
Write
Sends the email a site sends to its own users , order confirmations, password resets, booking reminders , through the workspace's verified domain.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send yourself a preview now
Write
Covers the period the next send would.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Start an automation for one contact
Write
Enrols a single contact, bypassing trigger matching, and runs the first steps straight away in the background of this request (a wait, or anything the request could not finish, is picked up by the.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Suppression counts, or check one address
Read
Without parameters: how many addresses are on the workspace's suppression list, split by reason.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Tell SendBeam that something happened
Write
Reports an event by NAME, and runs every active automation carrying the "Something happened elsewhere" trigger for that name.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
The brand kit
Read
The workspace's brand kit , or the built-in default when none has been saved (id is then null).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
The scheduled workspace report
Read
Whether a weekly or monthly report email is on, when it goes, to whom, and which sections it carries.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
The workspace's sending defaults
Read
The default pace for campaigns that set none (sendpacehours, null for as fast as the plan allows), the workspace's own hourly cap below the plan's (sendcaphour, null for the plan's figure), the.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Unarchive a list
Write
Restores an archived list exactly.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a campaign
Write
Updates a draft or scheduled campaign.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a contact
Write
Partially updates a contact.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a custom block
Write
Any of name, description, mjml and slots.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a custom field
Write
Changes label, type and/or options.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a feed
Write
Any subset of the create fields, plus status (active / paused).
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a form
Write
Updates the form identified by id in the body.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a list
Write
Renames a list, changes its description (an empty description clears it; an empty name is ignored), switches double opt-in on or off (a change to doubleoptin only affects people who join from then.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a segment
Write
Renames a segment and/or replaces its rules.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a tag
Write
Renames or recolours a tag.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a template
Write
Updates any of the template fields.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update an automation
Write
Updates any of name, description, triggertype, triggerconfig; if steps is present every existing step is replaced by the new array.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
Upload an image
Write
Hosts one image (PNG, JPEG, GIF or WebP by its bytes, 2 MB at most; SVG is refused) and returns its permanent public address for use in an email; storage is capped per plan and uploads at 120 an hour per workspace.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
A repeated request may repeat the external action. Review the previous result before retrying a write.
What a digest can contain
Read
Every section with its options; blocked names why this person may not add it for the scope asked about, or is null.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
Your digests
Read
The signed-in person's own digest emails (336), newest first: up to 10.
Permissions and limits
Account permissions
A SendBeam workspace API key with the permissions each call needs (Settings, API keys); writes need the Pro plan
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in SendBeam. A saved workflow is not a completed provider action.
Marketing · CONNECTION
