The BigMailer connector lets your AI agent act in each user's BigMailer account. Each user connects their own BigMailer API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 29 · 24 · 629 read24 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the BigMailer connection
In AgentKit > Connections, create a BigMailer connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'bigmailer'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize BigMailer:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'bigmailer_brands_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "bigmailer"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize BigMailer:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="bigmailer_brands_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their BigMailer credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbigmailer_brand_getGet one brand by ID.Read-onlyGet Brand
Get one brand by ID. Returns the brand's name, default sender, time zone, bounce settings and limits.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_brand_properties_listList brand properties: reusable values (such as an address or logo HTML) inserted with merge tags.Read-onlyList Brand Properties
List brand properties: reusable values (such as an address or logo HTML) inserted with merge tags. Returns each property's ID, name, merge tag and value.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_brands_listList the brands in the BigMailer account.Read-onlyList Brands
List the brands in the BigMailer account. Returns each brand's ID, name, sender defaults and contact counts. Use the brand ID with every other tool.
Inputs
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_bulk_campaign_getGet one bulk campaign.Read-onlyGet Bulk Campaign
Get one bulk campaign. Returns its content, audience, status, schedule and stats (sent, opens, clicks, bounces, unsubscribes).
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_bulk_campaign_url_clicks_listList link clicks for a bulk campaign.Read-onlyList Bulk Campaign Link Clicks
List link clicks for a bulk campaign. Returns each URL with its click counts.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
pageinteger- Page number, starting at 1. Example: 1.
per_pageinteger- Items per page. Example: 50.
bigmailer_bulk_campaigns_listList bulk (newsletter) campaigns, with cursor paging.Read-onlyList Bulk Campaigns
List bulk (newsletter) campaigns, with cursor paging. Returns each campaign's ID, name, subject, status, schedule and stats.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_connections_listList the sending connections (Amazon SES accounts) linked to BigMailer.Read-onlyList Connections
List the sending connections (Amazon SES accounts) linked to BigMailer. Returns each connection's ID, type and status.
Inputs
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_contact_getGet one contact by ID or email address.Read-onlyGet Contact
Get one contact by ID or email address. Returns the contact's email, field values, lists and unsubscribe settings.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
contact_idstringrequired- ID or email address of the contact. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_contacts_batch_getGet the status of a contact batch upload.Read-onlyGet Contact Batch Status
Get the status of a contact batch upload. Returns the batch status and counts of created, updated and failed contacts with errors.
Inputs
batch_idstringrequired- ID of the contact batch. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_contacts_listList contacts in a brand, optionally only those on one list, with cursor paging.Read-onlyList Contacts
List contacts in a brand, optionally only those on one list, with cursor paging. Returns each contact's ID, email, field values, lists and unsubscribes. Use bigmailer_contact_get for one contact.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
list_idstring- Only contacts on this list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_fields_listList fields in a brand, with cursor paging.Read-onlyList Fields
List fields in a brand, with cursor paging. Returns each field's ID, name and settings, and a cursor for the next page.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_list_getGet one list by ID.Read-onlyGet List
Get one list by ID. Returns the list's details.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
list_idstringrequired- ID of the list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_lists_listList lists in a brand, with cursor paging.Read-onlyList Lists
List lists in a brand, with cursor paging. Returns each list's ID, name and settings, and a cursor for the next page.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_message_types_listList message types, which contacts can unsubscribe from separately.Read-onlyList Message Types
List message types, which contacts can unsubscribe from separately. Returns each type's ID and name.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
typestring- Only message types of this type. Example: all.one of
allaccountuser
bigmailer_rss_campaign_getGet one RSS-to-email campaign.Read-onlyGet RSS Campaign
Get one RSS-to-email campaign. Returns its feed, schedule, content and status.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_rss_campaign_updates_listList the emails an RSS campaign has sent (one per feed update).Read-onlyList RSS Campaign Sends
List the emails an RSS campaign has sent (one per feed update). Returns each send's ID, subject, date and stats.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
parent_idstringrequired- ID of the RSS campaign. Get it from bigmailer_rss_campaigns_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_rss_campaigns_listList RSS-to-email campaigns.Read-onlyList RSS Campaigns
List RSS-to-email campaigns. Returns each campaign's ID, name, feed URL, schedule and status.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_segment_getGet one segment by ID.Read-onlyGet Segment
Get one segment by ID. Returns the segment's details.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
segment_idstringrequired- ID of the segment. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_segments_listList segments in a brand, with cursor paging.Read-onlyList Segments
List segments in a brand, with cursor paging. Returns each segment's ID, name and settings, and a cursor for the next page.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_sender_getGet one sender by ID.Read-onlyGet Sender
Get one sender by ID. Returns the sender's details.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
sender_idstringrequired- ID of the sender. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_senders_listList senders in a brand, with cursor paging.Read-onlyList Senders
List senders in a brand, with cursor paging. Returns each sender's ID, name and settings, and a cursor for the next page.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_suppression_list_getGet one campaign suppression list.Read-onlyGet Suppression List
Get one campaign suppression list. Returns its name, status and count.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
suppression_list_idstringrequired- ID of the suppression list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_suppression_lists_listList campaign suppression lists (emails never to send a campaign to).Read-onlyList Suppression Lists
List campaign suppression lists (emails never to send a campaign to). Returns each list's ID, name and count.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_template_getGet one template by ID.Read-onlyGet Template
Get one template by ID. Returns the template's details.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
template_idstringrequired- ID of the template. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_templates_listList templates in a brand, with cursor paging.Read-onlyList Templates
List templates in a brand, with cursor paging. Returns each template's ID, name and settings, and a cursor for the next page.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_test_campaigns_listList test emails sent from the brand.Read-onlyList Test Campaigns
List test emails sent from the brand. Returns each test's ID, subject, recipients and date.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_transactional_campaign_getGet one transactional campaign.Read-onlyGet Transactional Campaign
Get one transactional campaign. Returns its content, sender, settings and stats.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_transactional_campaign_url_clicks_listList link clicks for a transactional campaign.Read-onlyList Transactional Link Clicks
List link clicks for a transactional campaign. Returns each URL with its click counts.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
pageinteger- Page number, starting at 1. Example: 1.
per_pageinteger- Items per page. Example: 50.
bigmailer_transactional_campaigns_listList transactional email campaigns (templates sent one at a time through the API).Read-onlyList Transactional Campaigns
List transactional email campaigns (templates sent one at a time through the API). Returns each campaign's ID, name, subject and stats.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
cursorstring- Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
limitinteger- Maximum number of items to return (up to 100). Example: 25.
bigmailer_brand_createCreate a brand with its default sender.WriteCreate Brand
Create a brand with its default sender. Returns the new brand's ID.
Inputs
from_emailstringrequired- Default email used in the "From:" header in campaigns sent from this brand. Example: news@acme.com.
from_namestringrequired- Default name used in the "From:" header in campaigns sent from this brand. Example: Acme.
namestringrequired- Name of the brand. Example: Acme.
bounce_danger_percentinteger- An integer percentage (0-100). If a bulk campaign in the brand reaches this threshold percent of bounces, it is paused automatically. Example: 3.
connection_idstring- ID of the sending connection. Get it from bigmailer_connections_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
contact_limitinteger- The maxmimum number of contacts the brand is allowed to contain. Example: 0.
max_soft_bouncesinteger- The maximum number of times a contact can soft bounce before it is considered undeliverable. Set to 0 to remove the limit on soft bounces. Example: 5.
timezonestring- IANA time zone, such as America/New_York. Example: America/New_York.
unsubscribe_textstring- A message displayed to contacts on the brand unsubscribe page. Example: Unsubscribe.
urlstring- URL of a website associated with the brand. Example: https://acme.com.
bigmailer_bulk_campaign_createCreate a bulk (newsletter) campaign for lists or a segment; set ready to true to send or schedule it.WriteCreate Bulk Campaign
Create a bulk (newsletter) campaign for lists or a segment; set ready to true to send or schedule it. Returns the new campaign's ID. Send a preview first with bigmailer_test_campaign_send.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestringrequired- Name of the campaign. Example: May newsletter.
auto_textboolean- True to generate the text body automatically from the HTML body. Example: true.
excluded_list_idsarray- IDs of lists to leave out. Example: [].
fromobject- Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
htmlstring- HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body><p>Hi *|FIRST_NAME|*</p></body></html>.
link_paramsstring- Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
list_idsarray- IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
message_type_idstring- ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
previewstring- Copy shown following your subject line in many email clients. Example: Our biggest update yet.
readyboolean- true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
recipient_namestring- Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
reply_toobject- Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
scheduled_forinteger- When to send, as a Unix timestamp; leave empty to send when ready. Example: 1780000000.
segment_idstring- ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
subjectstring- Subject line for the campaign. Example: What's new in May.
template_idstring- ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
textstring- Text body of the email. Example: Hi *|FIRST_NAME|*.
track_clicksboolean- True to enable click tracking in HTML links. Example: true.
track_opensboolean- True to enable open tracking (HTML campaigns only). Example: true.
bigmailer_bulk_campaign_updateUpdate a draft bulk campaign, or set ready to true to send or schedule it.WriteUpdate Bulk Campaign
Update a draft bulk campaign, or set ready to true to send or schedule it. Returns the campaign's ID. Only the fields you pass change.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
auto_textboolean- True to generate the text body automatically from the HTML body. Example: true.
excluded_list_idsarray- IDs of lists to leave out. Example: [].
fromobject- Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
htmlstring- HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body><p>Hi *|FIRST_NAME|*</p></body></html>.
link_paramsstring- Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
list_idsarray- IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
message_type_idstring- ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestring- Name of the campaign. Example: May newsletter.
previewstring- Copy shown following your subject line in many email clients. Example: Our biggest update yet.
readyboolean- true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
recipient_namestring- Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
reply_toobject- Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
scheduled_forinteger- When to send, as a Unix timestamp; leave empty to send when ready. Example: 1780000000.
segment_idstring- ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
subjectstring- Subject line for the campaign. Example: What's new in May.
template_idstring- ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
textstring- Text body of the email. Example: Hi *|FIRST_NAME|*.
track_clicksboolean- True to enable click tracking in HTML links. Example: true.
track_opensboolean- True to enable open tracking (HTML campaigns only). Example: true.
bigmailer_contact_createCreate a contact in a brand, with field values and list memberships.WriteCreate Contact
Create a contact in a brand, with field values and list memberships. Returns the new contact's ID. Use bigmailer_contact_upsert to update an existing email instead of failing.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
emailstringrequired- Email address of the contact. Example: jane@example.com.
field_valuesarray- Custom field values: each has the field name (merge tag) and a string, integer or date value. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
list_idsarray- IDs of the lists the contact is on. Get them from bigmailer_lists_list. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
unsubscribe_allboolean- true to unsubscribe the contact from all email. Example: false.
unsubscribe_idsarray- IDs of message types the contact is unsubscribed from. Example: [].
validatestring- true to validate the email address before saving. Example: true.one of
truefalse
bigmailer_contact_updateUpdate a contact's email, field values, lists or unsubscribes, replacing, adding to or removing from each list field.WriteUpdate Contact
Update a contact's email, field values, lists or unsubscribes, replacing, adding to or removing from each list field. Returns the contact's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
contact_idstringrequired- ID or email address of the contact. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
emailstring- Email address of the contact. Example: jane@example.com.
field_valuesarray- Custom field values: each has the field name (merge tag) and a string, integer or date value. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
field_values_opstring- How to apply field_values: replace, add or remove. Example: add.one of
addremovereplace list_idsarray- IDs of the lists the contact is on. Get them from bigmailer_lists_list. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
list_ids_opstring- How to apply list_ids: replace, add or remove. Example: add.one of
addremovereplace unsubscribe_allboolean- true to unsubscribe the contact from all email. Example: false.
unsubscribe_idsarray- IDs of message types the contact is unsubscribed from. Example: [].
unsubscribe_ids_opstring- How to apply unsubscribe_ids: replace, add or remove. Example: add.one of
addremovereplace
bigmailer_contact_upsertCreate a contact, or update it if the email already exists in the brand.WriteCreate or Update Contact
Create a contact, or update it if the email already exists in the brand. Returns the contact's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
emailstringrequired- Email address of the contact. Example: jane@example.com.
field_valuesarray- Custom field values: each has the field name (merge tag) and a string, integer or date value. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
list_idsarray- IDs of the lists the contact is on. Get them from bigmailer_lists_list. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
unsubscribe_allboolean- true to unsubscribe the contact from all email. Example: false.
unsubscribe_idsarray- IDs of message types the contact is unsubscribed from. Example: [].
validatestring- true to validate the email address before saving. Example: true.one of
truefalse
bigmailer_contacts_batch_uploadCreate or update many contacts in one asynchronous batch.WriteUpload Contact Batch
Create or update many contacts in one asynchronous batch. Returns the batch ID; check it with bigmailer_contacts_batch_get.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
itemsarrayrequired- Contacts to create or update, each like the contact create body (email, field_values, list_ids, unsubscribe_all, unsubscribe_ids). Example: [{"email": "jane@example.com", "list_ids": ["<list id>"]}].
validateboolean- true to validate the email addresses. Example: true.
bigmailer_field_createCreate a field in a brand.WriteCreate Field
Create a field in a brand. Returns the new field's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestringrequired- Name of the field. Example: First name.
typestringrequired- Type of the field. Example: text.one of
dateintegertext merge_tag_namestring- Merge tag used in emails as *|TAG|*, such as FIRST_NAME. Example: FIRST_NAME.
sample_valuestring- A value used for the field when sending test campaigns. Example: Jane.
bigmailer_list_createCreate a list in a brand.WriteCreate List
Create a list in a brand. Returns the new list's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestringrequired- Name of the list. Example: Newsletter.
bigmailer_list_updateUpdate a list.WriteUpdate List
Update a list. Returns the list's ID. Only the fields you pass change.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
list_idstringrequired- ID of the list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestring- Name of the list. Example: Newsletter 2026.
bigmailer_rss_campaign_createCreate an RSS-to-email campaign that emails new feed items on a schedule.WriteCreate RSS Campaign
Create an RSS-to-email campaign that emails new feed items on a schedule. Returns the new campaign's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestringrequired- Name of the campaign. Example: May newsletter.
auto_textboolean- True to generate the text body automatically from the HTML body. Example: true.
excluded_list_idsarray- IDs of lists to leave out. Example: [].
feed_urlstring- URL of the RSS feed. Example: https://example.com/feed.xml.
fromobject- Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
htmlstring- HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body><p>Hi *|FIRST_NAME|*</p></body></html>.
link_paramsstring- Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
list_idsarray- IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
message_type_idstring- ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
previewstring- Copy shown following your subject line in many email clients. Example: Our biggest update yet.
readyboolean- true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
recipient_namestring- Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
reply_toobject- Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
segment_idstring- ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
subjectstring- Subject line for the campaign. Example: What's new in May.
template_idstring- ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
textstring- Text body of the email. Example: Hi *|FIRST_NAME|*.
track_clicksboolean- True to enable click tracking in HTML links. Example: true.
track_opensboolean- True to enable open tracking (HTML campaigns only). Example: true.
bigmailer_rss_campaign_pausePause an RSS-to-email campaign.WritePause RSS Campaign
Pause an RSS-to-email campaign. Returns the campaign's ID.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_rss_campaign_unpauseResume a paused RSS-to-email campaign.WriteResume RSS Campaign
Resume a paused RSS-to-email campaign. Returns the campaign's ID.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_rss_campaign_updateUpdate an RSS-to-email campaign.WriteUpdate RSS Campaign
Update an RSS-to-email campaign. Returns the campaign's ID. Only the fields you pass change.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
auto_textboolean- True to generate the text body automatically from the HTML body. Example: true.
excluded_list_idsarray- IDs of lists to leave out. Example: [].
feed_urlstring- URL of the RSS feed. Example: https://example.com/feed.xml.
fromobject- Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
htmlstring- HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body><p>Hi *|FIRST_NAME|*</p></body></html>.
link_paramsstring- Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
list_idsarray- IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
message_type_idstring- ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestring- Name of the campaign. Example: May newsletter.
previewstring- Copy shown following your subject line in many email clients. Example: Our biggest update yet.
readyboolean- true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
recipient_namestring- Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
reply_toobject- Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
segment_idstring- ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
subjectstring- Subject line for the campaign. Example: What's new in May.
template_idstring- ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
textstring- Text body of the email. Example: Hi *|FIRST_NAME|*.
track_clicksboolean- True to enable click tracking in HTML links. Example: true.
track_opensboolean- True to enable open tracking (HTML campaigns only). Example: true.
bigmailer_segment_createCreate a segment in a brand.WriteCreate Segment
Create a segment in a brand. Returns the new segment's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
conditionsarrayrequired- Conditions, each with a type: field (id of a field, operator such as is or contains, and text_value, email_value, integer_value or date_value), date_added, campaign_activity (operator such as opened or clicked, optional campaign id and days), subscription, reference (another segment) or location. Example: [{"type": "campaign_activity", "operator": "opened", "days": 30}].
namestringrequired- Name of the segment. Example: Engaged.
operatorstringrequired- all to match every condition, any to match at least one. Example: all.one of
allany
bigmailer_segment_updateUpdate a segment.WriteUpdate Segment
Update a segment. Returns the segment's ID. Only the fields you pass change.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
segment_idstringrequired- ID of the segment. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
conditionsarray- An array of conditions that the segment must satisfy. See our [description of segment conditions](https://docs.bigmailer.io/docs/segments). Example: [{"type": "campaign_activity", "operator": "opened", "days": 30}].
namestring- Name of the segment. Example: Engaged.
operatorstring- all to match every condition, any to match at least one. Example: all.one of
allany
bigmailer_sender_createCreate a sender in a brand.WriteCreate Sender
Create a sender in a brand. Returns the new sender's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
identitystringrequired- Email address or domain to send from. Example: news@acme.com.
identity_typestring- email or domain. Example: email.one of
domainemail share_typestring- Set to all to share the sender with all brands. Set to none to use only within the current brand. Example: all.one of
allnone
bigmailer_sender_verifyStart or re-check verification of a sender email or domain.WriteVerify Sender
Start or re-check verification of a sender email or domain. Returns the sender's verification status. An email sender gets a verification email; a domain needs its DNS records.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
sender_idstringrequired- ID of the sender. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_template_createCreate a template in a brand.WriteCreate Template
Create a template in a brand. Returns the new template's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
htmlstringrequired- HTML body of the template. Example: <html><body>*|CONTENT|*</body></html>.
namestringrequired- Name of the template. Example: Newsletter layout.
typestringrequired- Type of campaigns the template may be used with. Example: email.one of
emailpage shared_with_accountboolean- true if the template is shared with all brands in the account. false otherwise. Example: false.
bigmailer_template_updateUpdate a template.WriteUpdate Template
Update a template. Returns the template's ID. Only the fields you pass change.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
template_idstringrequired- ID of the template. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
htmlstring- HTML body of the template. Example: <html><body>*|CONTENT|*</body></html>.
namestring- Name of the template. Example: Newsletter layout v2.
shared_with_accountboolean- true if the template is shared with all brands in the account. false otherwise. Example: false.
typestring- Type of campaigns the template may be used with. Example: email.one of
emailpage
bigmailer_test_campaign_sendSend a test email with campaign content to a few addresses.WriteSend Test Campaign
Send a test email with campaign content to a few addresses. Returns the test campaign's ID. Use it to preview content before sending a bulk campaign.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
recipientsarrayrequired- Email addresses to send the test to. Example: ["jane@example.com"].
auto_textboolean- True to generate the text body automatically from the HTML body. Example: true.
feed_urlstring- RSS feed URL, to test RSS content. Example: https://example.com/feed.xml.
fromobject- Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
htmlstring- HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body><p>Hi *|FIRST_NAME|*</p></body></html>.
previewstring- Copy shown following your subject line in many email clients. Example: Our biggest update yet.
recipient_namestring- Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
reply_toobject- Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
subjectstring- Subject line for the campaign. Example: What's new in May.
textstring- Text body of the email. Example: Hi *|FIRST_NAME|*.
track_clicksboolean- True to enable click tracking in HTML links. Example: true.
track_opensboolean- True to enable open tracking (HTML campaigns only). Example: true.
bigmailer_transactional_campaign_createCreate a transactional email campaign to send to single contacts through the API.WriteCreate Transactional Campaign
Create a transactional email campaign to send to single contacts through the API. Returns the new campaign's ID. Send it with bigmailer_transactional_email_send.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestringrequired- Name of the campaign. Example: May newsletter.
auto_textboolean- True to generate the text body automatically from the HTML body. Example: true.
fromobject- Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
htmlstring- HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body><p>Hi *|FIRST_NAME|*</p></body></html>.
list_idstring- List to add recipients to. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
message_type_idstring- ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
previewstring- Copy shown following your subject line in many email clients. Example: Our biggest update yet.
readyboolean- true to make the campaign ready to send. Example: true.
recipient_namestring- Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
reply_toobject- Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
subjectstring- Subject line for the campaign. Example: What's new in May.
template_idstring- ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
textstring- Text body of the email. Example: Hi *|FIRST_NAME|*.
track_clicksboolean- True to enable click tracking in HTML links. Example: true.
track_opensboolean- True to enable open tracking (HTML campaigns only). Example: true.
bigmailer_transactional_campaign_updateUpdate a transactional campaign's content, sender or settings.WriteUpdate Transactional Campaign
Update a transactional campaign's content, sender or settings. Returns the campaign's ID. Only the fields you pass change.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
auto_textboolean- True to generate the text body automatically from the HTML body. Example: true.
fromobject- Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
htmlstring- HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body><p>Hi *|FIRST_NAME|*</p></body></html>.
list_idstring- List to add recipients to. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
message_type_idstring- ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
namestring- Name of the campaign. Example: May newsletter.
previewstring- Copy shown following your subject line in many email clients. Example: Our biggest update yet.
readyboolean- true to make the campaign ready to send. Example: true.
recipient_namestring- Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
reply_toobject- Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
subjectstring- Subject line for the campaign. Example: What's new in May.
template_idstring- ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
textstring- Text body of the email. Example: Hi *|FIRST_NAME|*.
track_clicksboolean- True to enable click tracking in HTML links. Example: true.
track_opensboolean- True to enable open tracking (HTML campaigns only). Example: true.
bigmailer_transactional_email_sendSend a transactional campaign's email to one address, with field values and template variables.WriteSend Transactional Email
Send a transactional campaign's email to one address, with field values and template variables. Returns the send's ID.
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
campaign_idstringrequired- ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
emailstringrequired- Recipient email address. Example: jane@example.com.
field_valuesarray- Contact field values to save and merge. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
variablesarray- One-off template variables for this email. Example: [{"name": "ORDER_ID", "value": "A-1001"}].
bigmailer_contact_deleteDelete a contact from a brand.DestructiveDelete Contact
Delete a contact from a brand. Returns an empty response on success.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
contact_idstringrequired- ID or email address of the contact. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_field_deleteDelete a field.DestructiveDelete Field
Delete a field. Returns an empty response on success.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
field_idstringrequired- ID of the field. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_list_deleteDelete a list.DestructiveDelete List
Delete a list. Returns an empty response on success.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
list_idstringrequired- ID of the list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_segment_deleteDelete a segment.DestructiveDelete Segment
Delete a segment. Returns an empty response on success.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
segment_idstringrequired- ID of the segment. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_sender_deleteDelete a sender.DestructiveDelete Sender
Delete a sender. Returns an empty response on success.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
sender_idstringrequired- ID of the sender. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
bigmailer_template_deleteDelete a template.DestructiveDelete Template
Delete a template. Returns an empty response on success.
- Idempotent
Inputs
brand_idstringrequired- ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
template_idstringrequired- ID of the template. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
No tools match.