Email marketing for small business: draft, preview, schedule and report on campaigns.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Bearer followed by your Hollerpost API key (starts with hp_live_). Create one in the dashboard under Settings, Developer API.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Returns the plan, billing period end, email and SMS quota used and limit, and the send packs available. Free and read only. Check it before a large send. Plan changes and purchases are never done through tools: use billing_portal_link to give the person a link. Requires API key scope: read.
This tool takes no arguments.
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http mcp https://mcp.hollerpost.com/mcp \ --header 'Authorization: Bearer YOUR_TOKEN'
Headers
Authorization (required): Bearer followed by your Hollerpost API key (starts with hp_live_). Create one in the dashboard under Settings, Developer API.Returns the plan, billing period end, email and SMS quota used and limit, and the send packs available. Free and read only. Check it before a large send. Plan changes and purchases are never done through tools: use billing_portal_link to give the person a link. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Updates the workspace name, from name, reply-to address or the physical footer address (required by law in marketing email). Uses no quota. Reversible by setting the old value again. Billing can never be changed here. Confirm the new values with the person first. Requires API key scope: account.
| Argument | Type | Description |
|---|---|---|
| reply_to | string | Where replies go. |
| from_name | string | Name recipients see in the From field. |
| footer_address | string | Physical mailing address printed in every campaign footer. |
| workspace_name | string | Workspace or business name. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"reply_to": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Where replies go."
},
"from_name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Name recipients see in the From field."
},
"footer_address": {
"type": "string",
"maxLength": 300,
"minLength": 5,
"description": "Physical mailing address printed in every campaign footer."
},
"workspace_name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Workspace or business name."
}
}
}Returns a short-lived link to the Stripe billing portal for the person to open in their browser, where they can change plan, update a card or buy send packs. This is the only billing tool: you never change plans or buy anything yourself. Free; changes nothing. The link expires, so get a fresh one when needed and do not store it. Requires API key scope: account.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Returns the brand settings: workspace and from name, reply-to, logo, colors, footer address, the saved writing voice and the sending domain status. Free and read only. Read this before writing any campaign copy and follow the voice exactly. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Saves the brand voice notes (how this business writes: tone, words to use or avoid). Replaces the previous voice text entirely, so read brand_get first and include anything worth keeping. Uses no quota and sends nothing. Reversible by saving the old text again. Only save what the person dictated or approved. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| voice* | string | The full voice notes to save, in plain sentences. Replaces the current text. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"voice"
],
"properties": {
"voice": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "The full voice notes to save, in plain sentences. Replaces the current text."
}
}
}Cancels a scheduled campaign before it starts sending. Only works while the status is scheduled; once sending has started it cannot be stopped. Uses no quota. Confirm with the person which campaign they mean (campaigns_list with status scheduled) before calling. Requires API key scope: send.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id (a UUID), as returned by campaign_draft or campaigns_list. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Campaign id (a UUID), as returned by campaign_draft or campaigns_list."
}
}
}Creates a campaign as a DRAFT. Nothing is sent and no quota is used. Before calling: read brand_get for the voice, pick a template from templates_list, and pick the audience from segments_list. You fill the content blocks; Hollerpost renders the email with the brand header, footer and unsubscribe link. Optionally ask one survey question (survey) that readers answer with one click. Returns the id, audience_count and a preview_url to share with the person. Next step: campaign_preview, then campaign_send_test. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| name* | string | Internal campaign name (recipients do not see it). |
| blocks* | object | Content blocks for the template. Check templates_list for the blocks_schema of the template you pick. Never send raw HTML: Hollerpost renders the blocks with the brand header, footer, unsubscribe link and address. The plain template takes no images. |
| survey | object | Ask one survey question in the email; readers answer with one click. The survey must be open (survey_update with status "open") before the campaign can be test-sent or scheduled. |
| subject* | string | Email subject line. |
| audience* | any | Who gets it: {"tags": ["vip"]} for tagged contacts, or {"all": true} for every subscribed contact, or {"signup_form_id": "<UUID>"} for a waitlist. |
| preheader | string |
Renders a draft and returns the text version, the live audience_count, quota_after_send and warnings (empty subject, missing button, over quota, first campaign pending review). Free, read only, sends nothing. Always call this before campaign_schedule and tell the person the audience count, the quota it will use and every warning. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id (a UUID), as returned by campaign_draft or campaigns_list. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Campaign id (a UUID), as returned by campaign_draft or campaigns_list."
}
}
}Schedules a drafted campaign to send to its audience. This is not reversible once sending starts, and it uses one email of quota per recipient. Call campaign_preview first, tell the person the audience count and the quota it uses, and only call this after they say yes. Pass the audience count you showed them as expected_audience_count; if the list changed meaningfully the call is refused. A workspace's first campaign is held for a one-time human review instead of sending (review_pending); say so plainly and do not retry. Before send_at, campaign_cancel can still stop it. Requires API key scope: send.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id (a UUID), as returned by campaign_draft or campaigns_list. |
| confirm* | boolean | Must be true, and only after the person explicitly approved this send and its audience count. |
| send_at* | any | "now", or an ISO 8601 time with timezone such as 2026-10-05T09:00:00-07:00. |
| expected_audience_count* | integer | The audience count you showed the person from campaign_preview. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"send_at",
"expected_audience_count",
"confirm"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Campaign id (a UUID), as returned by campaign_draft or campaigns_list."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true, and only after the person explicitly approved this send and its audience count."
},
"send_at": {
"anyOf": [
{
"type": "string",
"const": "now"
},
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
],
"description": "\"now\", or an ISO 8601 time with timezone such as 2026-10-05T09:00:00-07:00."
},
"expected_audience_count": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "The audience count you showed the person from campaign_preview."
}
}
}Sends a test copy of a draft to up to 3 addresses. The addresses must belong to users of this workspace; other addresses are refused. Uses quota only for the test emails actually sent, does not touch the audience, and does not change the draft. Offer this after campaign_preview so the person can check it in their own inbox. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id (a UUID), as returned by campaign_draft or campaigns_list. |
| to* | array | 1 to 3 addresses of people who use this workspace. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"to"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Campaign id (a UUID), as returned by campaign_draft or campaigns_list."
},
"to": {
"type": "array",
"items": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"maxItems": 3,
"minItems": 1,
"description": "1 to 3 addresses of people who use this workspace."
}
}
}Returns delivery and engagement numbers for a campaign: sent, delivered, bounced, complained, opened, clicked, unsubscribed and top links. Free and read only. Requires API key scope: read.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id (a UUID), as returned by campaign_draft or campaigns_list. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Campaign id (a UUID), as returned by campaign_draft or campaigns_list."
}
}
}Edits a campaign while it is still a draft: any of name, template, subject, preheader, blocks, audience or the survey question. Fields you leave out stay as they are; blocks you pass replace the whole blocks object; survey null removes the question. Uses no quota and sends nothing. Refused with campaign_locked once the campaign is scheduled or sent. Run campaign_preview again after editing. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| id* | string | Campaign id (a UUID), as returned by campaign_draft or campaigns_list. |
| name | string | New internal name. |
| blocks | object | Content blocks for the template. Check templates_list for the blocks_schema of the template you pick. Never send raw HTML: Hollerpost renders the blocks with the brand header, footer, unsubscribe link and address. The plain template takes no images. |
| survey | any | Set the survey question, or null to remove it. |
| subject | string | New subject line. |
| audience | any | Who gets it: {"tags": ["vip"]} for tagged contacts, or {"all": true} for every subscribed contact, or {"signup_form_id": "<UUID>"} for a waitlist. |
| preheader | string | New preview text. |
| template_id |
Lists campaigns, newest first, optionally filtered by status (draft, scheduled, sending, sent, held_for_review, canceled). Free and read only. Requires API key scope: read.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many to return (1 to 100). |
| status | string | Only campaigns with this status. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many to return (1 to 100)."
},
"status": {
"enum": [
"draft",
"scheduled",
"sending",
"sent",
"held_for_review",
"canceled"
],
"type": "string",
"description": "Only campaigns with this status."
}
}
}Adds one contact, or merges tags into an existing one. Uses no send quota. ONLY add a person who agreed to receive marketing email from this business (for example they signed up, or the person you are helping confirms they opted in). If you are not sure, ask first. Addresses that unsubscribed, bounced or complained cannot be re-added. Not reversible through these tools (there is no delete tool), so check the email is right. Requires API key scope: contacts.
| Argument | Type | Description |
|---|---|---|
| tags | array | Tags to add, for example ["vip"]. Merged with existing tags. |
| email* | string | The contact email address. |
| consent* | boolean | Must be true. Confirms this person agreed to receive marketing email from this business. Never set it on a guess. |
| last_name | string | Last name. |
| first_name | string | First name, used for personalization. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"consent"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 25,
"description": "Tags to add, for example [\"vip\"]. Merged with existing tags."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "The contact email address."
},
"consent": {
"type": "boolean",
"const": true,
"description": "Must be true. Confirms this person agreed to receive marketing email from this business. Never set it on a guess."
},
"last_name": {
"type": "string",
"maxLength": 80,
"description": "Last name."
},
"first_name": {
"type": "string",
"maxLength": 80,
"description": "First name, used for personalization."
}
}
}Finds contacts by exact email, status or tag, newest first. Free and read only. Status "subscribed" means active; "unsubscribed" covers suppressed addresses. Returns at most `limit` rows (default 50, max 200). Requires API key scope: read.
| Argument | Type | Description |
|---|---|---|
| tag | string | Only contacts that carry this tag. |
| string | Exact email address to look up. | |
| limit | integer | How many rows to return (1 to 200, default 50). |
| status | string | Filter by status. subscribed = active, unsubscribed = suppressed. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"tag": {
"type": "string",
"description": "Only contacts that carry this tag."
},
"email": {
"type": "string",
"description": "Exact email address to look up."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "How many rows to return (1 to 200, default 50)."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"active",
"pending",
"suppressed"
],
"type": "string",
"description": "Filter by status. subscribed = active, unsubscribed = suppressed."
}
}
}Adds a sending domain (one per workspace) and returns the exact DNS records to create, plus registrar_hint (cloudflare, godaddy, namecheap, route53, vercel or unknown). Uses no quota. Safe to call again: an existing domain returns its current records. If you have a DNS provider tool for that registrar connected, offer to add the records yourself; otherwise show them as a table and point the person to their DNS settings or the Hollerpost dashboard. Then call domain_verify. Requires API key scope: account.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A sending domain or subdomain, for example mail.example.com. No https://, no path. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"pattern": "^(?!-)[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)+$",
"maxLength": 253,
"minLength": 3,
"description": "A sending domain or subdomain, for example mail.example.com. No https://, no path."
}
}
}Lists the sending domain and its status (pending, verified or failed) with each DNS record and whether it was found. Free and read only. Check this before drafting: a workspace that must send from its own domain cannot schedule until it is verified. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Removes the sending domain from this workspace. Destructive: campaigns cannot be scheduled from it afterwards, and adding it back gives new DNS records to set up again. Refused with domain_in_use while a campaign is scheduled on it. Uses no quota. Only call when the person explicitly asked to remove this exact domain. Requires API key scope: account.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A sending domain or subdomain, for example mail.example.com. No https://, no path. |
| confirm* | boolean | Must be true, and only after the person explicitly asked to remove this domain. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain",
"confirm"
],
"properties": {
"domain": {
"type": "string",
"pattern": "^(?!-)[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)+$",
"maxLength": 253,
"minLength": 3,
"description": "A sending domain or subdomain, for example mail.example.com. No https://, no path."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true, and only after the person explicitly asked to remove this domain."
}
}
}Re-checks the DNS records for a sending domain now and returns, per record, whether it was found plus expected vs actual values. Uses no quota, changes nothing, safe to repeat. DNS changes can take minutes to a few hours to show up; if records are missing right after adding them, wait a bit and try again. Explain any wrong record in plain words. Requires API key scope: account.
| Argument | Type | Description |
|---|---|---|
| domain* | string | A sending domain or subdomain, for example mail.example.com. No https://, no path. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"pattern": "^(?!-)[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)+$",
"maxLength": 253,
"minLength": 3,
"description": "A sending domain or subdomain, for example mail.example.com. No https://, no path."
}
}
}Stores an image on Hollerpost for use in an email and returns its https URL. Pass url (a public https image, for example from the business website) or data_base64 (the file itself). For a picture the person has on their device or dropped into the chat, use email_image_upload_link instead. JPEG, PNG, WebP or GIF, up to 5 MB (GIFs up to 2 MB). Hollerpost shrinks it to at most 1200px wide and saves it as JPEG, or PNG when it has transparency, so the returned type can differ from the upload. Emails link to the image rather than attaching it, so it adds nothing to the message size. Limits: 100 uploads per API key per 24 hours and 500 per workspace per 30 days, so upload each picture once and reuse its url. Use the returned url in image_url, a section image_url, or an image line in body_md: . Sends nothing. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| url | string | Public https URL of the image to copy. |
| filename | string | A file name, for example "junior-cues-banner.png". |
| data_base64 | string | The image file, base64 encoded (a data: URL prefix is fine). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"url": {
"type": "string",
"pattern": "^https:\\/\\/",
"maxLength": 2000,
"description": "Public https URL of the image to copy."
},
"filename": {
"type": "string",
"maxLength": 200,
"description": "A file name, for example \"junior-cues-banner.png\"."
},
"data_base64": {
"type": "string",
"maxLength": 7000000,
"description": "The image file, base64 encoded (a data: URL prefix is fine)."
}
}
}Makes a one-time Hollerpost page where the person can upload pictures from their own device (up to 10, JPEG, PNG, WebP or GIF, 5 MB each). Use it when the person has a picture you cannot pass as a public URL or base64, for example one they dropped into this chat. Give them upload_url, wait until they say they are done, then call email_images_list with the link_id to get each picture's URL. The link works once and expires after 30 minutes. Sends nothing. Requires API key scope: draft.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Lists images already stored on Hollerpost for this workspace, newest first, with their URLs, so you can reuse one instead of uploading it again. Pass link_id (from email_image_upload_link) to get just the pictures uploaded through that link, and whether the person has used it yet. Free and read only. Requires API key scope: read.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many recent images (default 20). |
| link_id | string | The link_id from email_image_upload_link. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "How many recent images (default 20)."
},
"link_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The link_id from email_image_upload_link."
}
}
}Sends ONE transactional email (a receipt, a reply, a booking confirmation) to one address right away. Not reversible, and it uses one email of quota. Never use it for marketing or to mail a list: campaigns are for that. Show the person the recipient, subject and body and get a yes before calling, then pass confirm: true. idempotency_key is required: reuse the same key if you retry so the email is not sent twice. Pass html, text, or both. Requires API key scope: send.
| Argument | Type | Description |
|---|---|---|
| to* | string | Recipient address. |
| html | string | HTML body (at most 200,000 characters). Hollerpost adds the brand header. |
| text | string | Plain text body (at most 50,000 characters). |
| confirm* | boolean | Must be true, and only after the person explicitly approved this exact recipient, subject and body. Never set it on a guess. |
| subject* | string | Subject line. |
| reply_to | string | Reply-to address, if different from the workspace default. |
| idempotency_key* | string | A unique key for this email, for example "receipt-1042". Reusing it returns the first result instead of sending again. |
Cancel an event and remove it from the public page, retaining its record. Ask for confirmation before calling; requires confirm: true. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| confirm* | boolean |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"confirm"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"confirm": {
"type": "boolean",
"const": true
}
}
}Create a calendar event. Defaults to draft. Status published shows it on Your page right away: ask the person first and pass confirm_publish: true. Use an IANA timezone and ISO dates with offsets. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| event* | object | |
| confirm_publish | boolean | true only after the person explicitly approved publishing; required whenever this call publishes. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"event"
],
"properties": {
"event": {
"type": "object",
"required": [
"title",
"starts_at",
"timezone"
],
"properties": {
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"status": {
"enum": [
"draft",
"published",
"canceled"
],
"type": "string"
},
"address": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"ends_at": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string"
},
"image_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"starts_at": {
"type": "string"
},
"online_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"ticket_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"venue_name": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"show_on_page": {
"type": "boolean"
}
}
},
"confirm_publish": {
"type": "boolean",
"const": true,
"description": "true only after the person explicitly approved publishing; required whenever this call publishes."
}
}
}List workspace calendar events, including upcoming and the past 90 days. These are calendar events, not email delivery events. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Update a calendar event by ID. Fields omitted are unchanged. Changes to a published event wait as a draft until the person approves publishing (confirm_publish: true). Setting status published needs the person's approval and confirm_publish: true. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| updates* | object | |
| confirm_publish | boolean | true only after the person explicitly approved publishing; required whenever this call publishes. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"updates"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"updates": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"status": {
"enum": [
"draft",
"published"
],
"type": "string"
},
"address": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"ends_at": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"timezone": {
"type": "string"
},
"image_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"starts_at": {
"type": "string"
},
"online_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"ticket_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"venue_name": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"show_on_page": {
"type": "boolean"
}
}
},
"confirm_publish": {
"type": "boolean",
"const": true,
"description": "true only after the person explicitly approved publishing; required whenever this call publishes."
}
}
}Lists recent delivery events of one type across campaigns and transactional mail: email.bounced (default), email.complained or email.delivered. Free and read only. Useful for list hygiene and deliverability questions. Requires API key scope: read.
| Argument | Type | Description |
|---|---|---|
| type | string | Event type (default email.bounced). |
| limit | integer | How many events (1 to 100, default 25). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"type": {
"enum": [
"email.bounced",
"email.complained",
"email.delivered"
],
"type": "string",
"description": "Event type (default email.bounced)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many events (1 to 100, default 25)."
}
}
}Read the Launchpad card: confirmed_signups, emailable_subscribers, awaiting_confirmation, confirmed this week and queued confirmations, confirmation allowance, list size versus plan emails, share URL, launch_url, main_page and the launch page's saved settings (launch_page: launch note, first button, published). The launch page is separate from Your page; main_page says which one hollerpost.com/@handle shows. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Switch the launch page to live mode and request publication after automatic checks. First use launchpad_get, show the person the saved launch note and primary link (the first button: its label and where it goes, a link or Your page), and wait for a clear yes. Requires confirm: true after that approval and a claimed handle with an enabled safe HTTPS primary link or primary_target page. A pending_review or review_pending hold is not live: explain owner_reason, do not retry or bypass review. Sends no campaign. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| confirm* | boolean | true only after the person saw the launch note and primary link and approved going live. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"confirm"
],
"properties": {
"confirm": {
"type": "boolean",
"const": true,
"description": "true only after the person saw the launch note and primary link and approved going live."
}
}
}Save the launch page's headline, pitch, count visibility, launch note, first button (a link or Your page) or mode (waitlist, to flip back from live). Omitted fields stay unchanged. Saves a draft only, including when an older approved page is public. Does not publish. Your page is not changed. Use launchpad_get to read the saved launch note and first button before asking the person to go live. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| mode | string | |
| show_count | boolean | |
| launch_note | string | |
| primary_label | string | Button words when primary_target is page. |
| primary_target | string | Where the live first button goes: link (primary_link_id) or page (the workspace's Your page, shown only while Your page is published). |
| waitlist_pitch | string | |
| primary_link_id | any | An enabled, safe HTTPS page link in this workspace. Live mode needs it unless primary_target is page; null clears it. |
| waitlist_headline | string |
Read Your page, links, events, handle and plan settings, plus main_page (which page hollerpost.com/@handle shows: page or launch), publicUrl and pageUrl (/@handle/links). An unsaved draft from the brand kit is returned if no page exists. The launch page is read with launchpad_get. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Add a HTTPS link to Your page (maximum 30). Known URL shorteners are refused. On a published page the change is saved as a draft and the public page keeps its approved version until the person approves publishing; then pass confirm_publish: true. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| link* | object | |
| confirm_publish | boolean | true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"link"
],
"properties": {
"link": {
"type": "object",
"required": [
"label",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"label": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"ends_at": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"maximum": 29,
"minimum": 0
},
"starts_at": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"thumbnail_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
}
}
},
"confirm_publish": {
"type": "boolean",
"const": true,
"description": "true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft."
}
}
}Permanently remove a page link. Ask for confirmation before calling; requires confirm: true. On a published page the change is saved as a draft and the public page keeps its approved version until the person approves publishing; then pass confirm_publish: true. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| confirm* | boolean | |
| confirm_publish | boolean | true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"confirm"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"confirm": {
"type": "boolean",
"const": true
},
"confirm_publish": {
"type": "boolean",
"const": true,
"description": "true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft."
}
}
}Update a workspace page link by ID. Omitted fields stay unchanged. On a published page the change is saved as a draft and the public page keeps its approved version until the person approves publishing; then pass confirm_publish: true. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| updates* | object | |
| confirm_publish | boolean | true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"updates"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"updates": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
},
"label": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"enabled": {
"type": "boolean"
},
"ends_at": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"maximum": 29,
"minimum": 0
},
"starts_at": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"thumbnail_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
}
}
},
"confirm_publish": {
"type": "boolean",
"const": true,
"description": "true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft."
}
}
}Replace link ordering. Include every workspace link ID exactly once. On a published page the change is saved as a draft and the public page keeps its approved version until the person approves publishing; then pass confirm_publish: true. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| ids* | array | |
| confirm_publish | boolean | true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"maxItems": 30
},
"confirm_publish": {
"type": "boolean",
"const": true,
"description": "true only after the person explicitly approved publishing; without it, changes to a published page wait as a draft."
}
}
}Update Your page fields (not the launch page: use launchpad_update). Arrays replace existing values. Publishing (published: true) needs the person's approval and confirm_publish: true. Without it, edits to a page that is already published are saved as a draft and the public page keeps its approved version. Automatic checks may hold changes for review; inspect pending_review, moderation_status and owner_reason before claiming publication. Requires a claimed handle; Free must show the badge. HTTPS destinations and contrast are enforced by the API. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| updates* | object | |
| confirm_publish | boolean | true only after the person explicitly approved publishing; required whenever this call publishes. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"updates"
],
"properties": {
"updates": {
"type": "object",
"properties": {
"info": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"hours": {
"type": "string"
},
"phone": {
"type": "string"
},
"website": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"address_mode": {
"enum": [
"none",
"city",
"full"
],
"type": "string"
}
}
},
"theme": {
"type": "object",
"properties": {
"layout": {
"enum": [
"centered",
"left",
"card"
],
"type": "string",
"description": "centered, left aligned, or the page on a card over the background."
},
"linkStyle": {
"enum": [
"button",
"outline",
"pill",
"todo",
"checklist",
"microchip",
"clouds",
"ticket"
],
"type": "string",
"description": "How the page links look. button: solid buttons (default). outline: outlined buttons. pill: round pills with an arrow. todo: to-do list rows with an empty box. checklist: rows with a ticked box. microchip: cyberpunk chips with notched corners. clouds: puffy cloud shapes. ticket: admission tickets with notched sides. Colors come from the theme; the main link and signup button stay solid."
},
"textColor": {
"type": "string"
},
"brandColor": {
"type": "string"
},
"fontFamily": {
"enum": [
"Nunito Sans",
"Nunito",
"sans-serif",
"serif",
"monospace",
"Arial",
"Georgia",
"Lora",
"Outfit",
"Manrope",
"Bricolage Grotesque",
"Space Mono"
],
"type": "string",
"description": "Body text font."
},
"accentColor": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"description": "Six-digit hex accent for background patterns and details."
},
"headingFont": {
"enum": [
"body",
"Fraunces",
"Instrument Serif",
"Lora",
"Outfit",
"Manrope",
"Bricolage Grotesque",
"Nunito",
"Nunito Sans",
"Unbounded",
"Caveat",
"Pacifico",
"Space Mono"
],
"type": "string",
"description": "Headline font. body means the same as fontFamily."
},
"buttonRadius": {
"type": "integer",
"maximum": 40,
"minimum": 0
},
"backgroundColor": {
"type": "string"
},
"backgroundStyle": {
"enum": [
"solid",
"gradient",
"glow",
"dots",
"grid",
"lined",
"stripes",
"checker",
"sunburst"
],
"type": "string",
"description": "Background behind the page. Text keeps 4.5:1 contrast against the pattern too (the API checks)."
},
"buttonTextColor": {
"type": "string"
}
},
"description": "The whole look. Send every field you want to keep: the theme replaces the saved one. A theme without accentColor, backgroundStyle, headingFont and layout keeps the classic look."
},
"title": {
"type": "string",
"maxLength": 120
},
"socials": {
"type": "array",
"items": {
"type": "object",
"required": [
"network",
"url"
],
"properties": {
"url": {
"type": "string"
},
"network": {
"enum": [
"instagram",
"tiktok",
"facebook",
"youtube",
"x",
"threads",
"bluesky",
"linkedin",
"pinterest",
"snapchat",
"twitch",
"discord",
"whatsapp",
"spotify",
"website"
],
"type": "string"
}
}
},
"maxItems": 15
},
"tagline": {
"type": "string",
"maxLength": 240
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"heading",
"body"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{0,39}$",
"description": "Keep the id of an existing section; leave it out for a new one."
},
"body": {
"type": "string",
"maxLength": 1500,
"minLength": 1,
"description": "Plain text. Separate paragraphs with a blank line. No HTML, no markdown links."
},
"kind": {
"type": "string",
"const": "story",
"description": "Always story."
},
"heading": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "Section heading, plain text."
},
"image_alt": {
"type": "string",
"maxLength": 200,
"description": "Required with image_url: what the picture shows."
},
"image_url": {
"type": "string",
"maxLength": 2048,
"description": "Optional picture. Must be an https://images.hollerpost.com URL: store it with email_image_upload first."
}
},
"additionalProperties": false
},
"maxItems": 8,
"description": "Story sections shown between the signup form and the links, in order. The FULL list: it replaces the saved one, so read page_get first and send every section to keep (with its id). Send [] to remove them all."
},
"published": {
"type": "boolean"
},
"avatar_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"show_badge": {
"type": "boolean"
},
"show_events": {
"type": "boolean"
},
"signup_form_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"confirm_publish": {
"type": "boolean",
"const": true,
"description": "true only after the person explicitly approved publishing; required whenever this call publishes."
}
}
}Lists contact tags and built-in waitlist audiences (signup_form_id) with subscribed counts. Free and read only. Use it to choose a campaign audience by tag or signup_form_id and to tell the person roughly how many people a send reaches. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Lists toll-free numbers available for this workspace's first texting registration. Optional prefix (800, 833, 844, 855, 866, 877, 888). Read only: nothing is bought until sms_registration_submit. Requires API key scope: account.
| Argument | Type | Description |
|---|---|---|
| prefix | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"prefix": {
"enum": [
"800",
"833",
"844",
"855",
"866",
"877",
"888"
],
"type": "string"
}
}
}Sends the registration to the carriers for review. The first time it also buys the chosen toll-free number (phone_number from sms_numbers, included in the person's add-on). After a rejection it resubmits the same request with the fixes. Only after the person reviewed the form (sms_setup_status) and said yes: needs confirm: true. Every check runs again first; if one fails, nothing is sent or bought. Review takes 1 to 2 weeks, sometimes a month; never promise a date. The person gets an email when the status changes. Requires API key scope: account.
| Argument | Type | Description |
|---|---|---|
| confirm* | boolean | true: the person approved submitting. |
| phone_number | string | First submission only: the toll-free number the person picked, E.164 (+18335550100). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"confirm"
],
"properties": {
"confirm": {
"type": "boolean",
"const": true,
"description": "true: the person approved submitting."
},
"phone_number": {
"type": "string",
"pattern": "^\\+18(00|33|44|55|66|77|88)\\d{7}$",
"description": "First submission only: the toll-free number the person picked, E.164 (+18335550100)."
}
}
}Saves fields of the toll-free texting registration as a draft (only while it is a draft or was rejected; never while the carriers review it). Send only the fields you are changing. Every fact must come from the person: ask for the legal name, entity type, address, contact and how people opt in; never guess or invent them, because carriers reject registrations that don't match official records. You may draft the use case summary, opt-in description and sample messages for the person to approve: each sample starts with the business name and ends "Reply STOP to opt out". The registration number (EIN, or SSN for a sole proprietor) cannot be set here: the person enters it in the dashboard. Returns the saved form (number masked) and the checklist. Nothing is sent to the carriers. Requires API key scope: account.
| Argument | Type | Description |
|---|---|---|
| form* | object | Only the fields to change. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"form"
],
"properties": {
"form": {
"type": "object",
"properties": {
"dba": {
"type": "string",
"maxLength": 500,
"description": "Brand name customers see, if different."
},
"zip": {
"type": "string",
"maxLength": 500
},
"city": {
"type": "string",
"maxLength": 500
},
"state": {
"type": "string",
"maxLength": 500
},
"samples": {
"type": "array",
"items": {
"type": "string",
"maxLength": 320
},
"maxItems": 3,
"description": "Up to 3 example messages."
},
"website": {
"type": "string",
"maxLength": 500
},
"address1": {
"type": "string",
"maxLength": 500
},
"address2": {
"type": "string",
"maxLength": 500
},
"age_gate": {
"type": "boolean"
},
"vertical": {
"enum": [
"general",
"alcohol",
"cannabis_cbd",
"lead_resale",
"mlm",
"tobacco_vape",
"firearms",
"adult",
"gambling",
"high_risk_finance"
],
"type": "string",
"description": "Kind of business. Most are general; some kinds cannot be registered at all."
},
"terms_url": {
"type": "string",
"maxLength": 500
},
"legal_name": {
"type": "string",
"maxLength": 500,
"description": "Exactly as on the official registration."
},
"opt_in_url": {
"type": "string",
"maxLength": 500,
"description": "Page where people sign up for texts."
},
"entity_type": {
"enum": [
"PRIVATE_PROFIT",
"SOLE_PROPRIETOR",
"NON_PROFIT",
"PUBLIC_PROFIT",
"GOVERNMENT"
],
"type": "string"
},
"privacy_url": {
"type": "string",
"maxLength": 500
},
"contact_email": {
"type": "string",
"maxLength": 500
},
"contact_phone": {
"type": "string",
"maxLength": 500
},
"confirm_opt_in": {
"type": "boolean",
"description": "The person confirmed everyone they text agreed to it."
},
"monthly_volume": {
"type": "string",
"maxLength": 500
},
"confirm_website": {
"type": "boolean",
"description": "The person confirmed the website is theirs and public."
},
"use_case_summary": {
"type": "string",
"maxLength": 500,
"description": "What the texts are for."
},
"contact_last_name": {
"type": "string",
"maxLength": 500
},
"contact_first_name": {
"type": "string",
"maxLength": 500
},
"opt_in_description": {
"type": "string",
"maxLength": 500,
"description": "How people agree to get texts, in plain words."
},
"registration_country": {
"type": "string",
"maxLength": 2,
"minLength": 2,
"description": "2-letter country code, e.g. US."
},
"opt_in_screenshot_url": {
"type": "string",
"maxLength": 2000
}
},
"description": "Only the fields to change.",
"additionalProperties": false
}
}
}Returns where this workspace stands on texting: the status of its own toll-free number registration (none, draft, submitted, in_review, rejected or verified), the number, when it was submitted, the saved form (registration number masked), the checklist the business must meet, the latest website check results, and, after a rejection, a plain explanation with fix steps. Free and read only. Carriers only deliver marketing texts from a toll-free number verified under the business itself, which takes 1 to 2 weeks and sometimes up to a month: never promise a date. Use it to walk the person through the checklist item by item (privacy policy sentence, optional standalone opt-in, sample messages starting with the brand and ending "Reply STOP to opt out"). With the account scope you can fill and fix the form (sms_registration_update), run the checks (sms_website_check) and submit after a yes (sms_registration_submit); the registration number is always entered in the dashboard at setup_url. Text campaigns cannot be scheduled until status is verified. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Runs every check the carriers care about on the saved registration, without submitting: missing or invalid form fields, and a live look at the person's website, privacy policy and terms (public, has the business name and address, and the privacy policy has the required sentence about mobile information). A few runs per 10 minutes. Use the results to help the person fix their form or their own site, then check again. Requires API key scope: account.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Creates a survey as a DRAFT: its page is not public and no email can ask its questions until it is opened with survey_update. Give it a name and 1 to 30 questions. Returns the survey with each question id; one_click questions (rating, nps, single) can go in an email with campaign_draft. Sends nothing and uses no quota. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| name* | string | Survey name, also used as the page title unless title is set. |
| intro | string | Short intro under the heading. |
| title | string | Heading on the survey page. |
| questions* | array | |
| thank_you_message | string | Shown after someone answers. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"questions"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Survey name, also used as the page title unless title is set."
},
"intro": {
"type": "string",
"maxLength": 1000,
"description": "Short intro under the heading."
},
"title": {
"type": "string",
"maxLength": 200,
"description": "Heading on the survey page."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,40}$",
"description": "Keep a question’s existing id when editing so earlier answers stay matched. Leave out for new questions."
},
"type": {
"enum": [
"rating",
"nps",
"single",
"multi",
"text",
"long_text"
],
"type": "string",
"description": "rating (1 to 5 stars, or up to 10), nps (0 to 10 recommend score), single (pick one), multi (pick any), text (one line), long_text (paragraph). Only rating, nps and single can be answered from inside an email."
},
"scale": {
"type": "object",
"properties": {
"max": {
"type": "integer",
"maximum": 10,
"minimum": 3,
"description": "Top of a rating scale (default 5). Ignored for nps."
},
"labels": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 2,
"description": "Up to two end labels, for example [\"Poor\", \"Great\"]."
}
}
},
"prompt": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "The question as the reader sees it."
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"label"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z0-9_-]{1,40}$",
"description": "Short stable key, for example \"yes\". Made up when left out."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 5,
"description": "Tags added to a contact who picks this option."
},
"label": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "What the reader sees."
}
}
},
"maxItems": 20,
"minItems": 2,
"description": "Choices for single and multi questions (2 to 20)."
},
"required": {
"type": "boolean",
"description": "Defaults to true."
}
}
},
"maxItems": 30,
"minItems": 1
},
"thank_you_message": {
"type": "string",
"maxLength": 1000,
"description": "Shown after someone answers."
}
}
}Returns aggregated results for one survey: response and completion counts, and per question the answer counts, average rating, NPS (promoters minus detractors) and the latest written answers. No contact identities. Free and read only. Summarize trends in plain words; do not over-read small samples. Requires API key scope: read.
| Argument | Type | Description |
|---|---|---|
| survey_id* | string | Survey id (a UUID), as returned by survey_create or surveys_list. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"survey_id"
],
"properties": {
"survey_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Survey id (a UUID), as returned by survey_create or surveys_list."
}
}
}Edits a survey, or opens or closes it with status. Opening makes the survey page public and lets campaigns that ask its questions be test-sent and scheduled; closing stops new answers. Questions you pass replace the whole list; keep each existing question id so earlier answers stay matched. Fields you leave out stay as they are. Sends nothing. Requires API key scope: draft.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| intro | string | |
| title | string | |
| status | string | "open" to start taking answers, "closed" to stop, "draft" to take it offline. |
| questions | array | |
| survey_id* | string | Survey id (a UUID), as returned by survey_create or surveys_list. |
| thank_you_message | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"survey_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"intro": {
"type": "string",
"maxLength": 1000
},
"title": {
"type": "string",
"maxLength": 200
},
"status": {
"enum": [
"draft",
"open",
"closed"
],
"type": "string",
"description": "\"open\" to start taking answers, \"closed\" to stop, \"draft\" to take it offline."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"prompt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,40}$",
"description": "Keep a question’s existing id when editing so earlier answers stay matched. Leave out for new questions."
},
"type": {
"enum": [
"rating",
"nps",
"single",
"multi",
"text",
"long_text"
],
"type": "string",
"description": "rating (1 to 5 stars, or up to 10), nps (0 to 10 recommend score), single (pick one), multi (pick any), text (one line), long_text (paragraph). Only rating, nps and single can be answered from inside an email."
},
"scale": {
"type": "object",
"properties": {
"max": {
"type": "integer",
"maximum": 10,
"minimum": 3,
"description": "Top of a rating scale (default 5). Ignored for nps."
},
"labels": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 2,
"description": "Up to two end labels, for example [\"Poor\", \"Great\"]."
}
}
},
"prompt": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "The question as the reader sees it."
},
"options": {
"type": "array",
"items": {
"type": "object",
"required": [
"label"
],
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z0-9_-]{1,40}$",
"description": "Short stable key, for example \"yes\". Made up when left out."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 5,
"description": "Tags added to a contact who picks this option."
},
"label": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "What the reader sees."
}
}
},
"maxItems": 20,
"minItems": 2,
"description": "Choices for single and multi questions (2 to 20)."
},
"required": {
"type": "boolean",
"description": "Defaults to true."
}
}
},
"maxItems": 30,
"minItems": 1
},
"survey_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Survey id (a UUID), as returned by survey_create or surveys_list."
},
"thank_you_message": {
"type": "string",
"maxLength": 1000
}
}
}Lists the workspace’s surveys with status (draft, open or closed), response count, questions (with ids and whether each can be answered from an email) and, when open, the public link to share. Free and read only. Use survey_results for the answers. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Lists the email templates and, for each, the blocks_schema (JSON Schema for heading, body_md, cta_text, cta_url, image_url, image_alt and sections). Free and read only. Pick a template here before campaign_draft and fill only the blocks its schema accepts. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Start here. Returns who this key belongs to: workspace name, plan, the scopes this key has, and the brand (voice, colors, from name, sending domain). Free and read only; uses no quota. Call it at the start of a conversation so you know which tools this key may use and how to write on-brand. Requires API key scope: read.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 16, 2026.
| Preview text shown after the subject in most inboxes. |
| template_id* | string | Template id from templates_list. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"template_id",
"subject",
"blocks",
"audience"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Internal campaign name (recipients do not see it)."
},
"blocks": {
"type": "object",
"properties": {
"body_md": {
"type": "string",
"description": "Body copy in Markdown: blank line between paragraphs, \"- \" lists, **bold**, *italic*, [text](https://...). To add a picture, put it on a line by itself:  or, clickable, [](https://link). Images inside a sentence are refused."
},
"cta_url": {
"type": "string",
"description": "Button link (https URL)."
},
"heading": {
"type": "string",
"description": "Main heading of the email."
},
"cta_text": {
"type": "string",
"description": "Button label, for example \"Book a visit\"."
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"body_md": {
"type": "string",
"maxLength": 3000,
"description": "Copy for this section. Same Markdown as body_md, image lines allowed."
},
"cta_url": {
"type": "string",
"pattern": "^https:\\/\\/",
"maxLength": 2000,
"description": "Button link for this section."
},
"heading": {
"type": "string",
"maxLength": 140,
"description": "Sub-heading for this section."
},
"cta_text": {
"type": "string",
"maxLength": 40,
"description": "Button label for this section."
},
"image_alt": {
"type": "string",
"maxLength": 140,
"description": "What the image shows. Required when image_url is set."
},
"image_url": {
"type": "string",
"pattern": "^https:\\/\\/",
"maxLength": 2000,
"description": "Section image (https URL). Use email_image_upload first to host it on Hollerpost."
},
"image_link": {
"type": "string",
"pattern": "^https:\\/\\/",
"maxLength": 2000,
"description": "Where a click on the image goes. Defaults to cta_url."
},
"image_position": {
"enum": [
"top",
"left",
"right"
],
"type": "string",
"description": "top (default): image above the copy. left or right: image beside the copy on wide screens, stacked on phones."
}
},
"additionalProperties": false
},
"maxItems": 8,
"description": "Optional: up to 8 sections after body_md, each with its own sub-heading, image, copy and button, divided by a line. Use for a promotion with several products or a newsletter with several stories. Each needs at least a heading, body_md or image_url. Up to 20 images per email in total."
},
"image_alt": {
"type": "string",
"description": "Alt text for the hero image. Required whenever image_url is set."
},
"image_url": {
"type": "string",
"description": "Optional hero image at the top (https URL). For more pictures use image lines in body_md or sections."
}
},
"description": "Content blocks for the template. Check templates_list for the blocks_schema of the template you pick. Never send raw HTML: Hollerpost renders the blocks with the brand header, footer, unsubscribe link and address. The plain template takes no images.",
"additionalProperties": {
"type": "string"
}
},
"survey": {
"type": "object",
"required": [
"survey_id",
"question_id"
],
"properties": {
"survey_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Survey id (a UUID), as returned by survey_create or surveys_list."
},
"question_id": {
"type": "string",
"minLength": 1,
"description": "Id of one question in that survey. Only rating, nps and single-choice questions (one_click: true) can be answered from an email."
}
},
"description": "Ask one survey question in the email; readers answer with one click. The survey must be open (survey_update with status \"open\") before the campaign can be test-sent or scheduled."
},
"subject": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Email subject line."
},
"audience": {
"anyOf": [
{
"type": "object",
"required": [
"signup_form_id"
],
"properties": {
"signup_form_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Form UUID from segments_list audiences or page_get. Only confirmed, active, unsuppressed email subscribers from this form, resolved when sending."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "Send to subscribed contacts that have ANY of these tags (one tag is the usual case). Get tags from segments_list."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"all"
],
"properties": {
"all": {
"type": "boolean",
"const": true,
"description": "Send to every subscribed contact in the workspace."
}
},
"additionalProperties": false
}
],
"description": "Who gets it: {\"tags\": [\"vip\"]} for tagged contacts, or {\"all\": true} for every subscribed contact, or {\"signup_form_id\": \"<UUID>\"} for a waitlist."
},
"preheader": {
"type": "string",
"maxLength": 200,
"description": "Preview text shown after the subject in most inboxes."
},
"template_id": {
"type": "string",
"minLength": 1,
"description": "Template id from templates_list."
}
}
}| string |
| New template id from templates_list. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Campaign id (a UUID), as returned by campaign_draft or campaigns_list."
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "New internal name."
},
"blocks": {
"type": "object",
"properties": {
"body_md": {
"type": "string",
"description": "Body copy in Markdown: blank line between paragraphs, \"- \" lists, **bold**, *italic*, [text](https://...). To add a picture, put it on a line by itself:  or, clickable, [](https://link). Images inside a sentence are refused."
},
"cta_url": {
"type": "string",
"description": "Button link (https URL)."
},
"heading": {
"type": "string",
"description": "Main heading of the email."
},
"cta_text": {
"type": "string",
"description": "Button label, for example \"Book a visit\"."
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"body_md": {
"type": "string",
"maxLength": 3000,
"description": "Copy for this section. Same Markdown as body_md, image lines allowed."
},
"cta_url": {
"type": "string",
"pattern": "^https:\\/\\/",
"maxLength": 2000,
"description": "Button link for this section."
},
"heading": {
"type": "string",
"maxLength": 140,
"description": "Sub-heading for this section."
},
"cta_text": {
"type": "string",
"maxLength": 40,
"description": "Button label for this section."
},
"image_alt": {
"type": "string",
"maxLength": 140,
"description": "What the image shows. Required when image_url is set."
},
"image_url": {
"type": "string",
"pattern": "^https:\\/\\/",
"maxLength": 2000,
"description": "Section image (https URL). Use email_image_upload first to host it on Hollerpost."
},
"image_link": {
"type": "string",
"pattern": "^https:\\/\\/",
"maxLength": 2000,
"description": "Where a click on the image goes. Defaults to cta_url."
},
"image_position": {
"enum": [
"top",
"left",
"right"
],
"type": "string",
"description": "top (default): image above the copy. left or right: image beside the copy on wide screens, stacked on phones."
}
},
"additionalProperties": false
},
"maxItems": 8,
"description": "Optional: up to 8 sections after body_md, each with its own sub-heading, image, copy and button, divided by a line. Use for a promotion with several products or a newsletter with several stories. Each needs at least a heading, body_md or image_url. Up to 20 images per email in total."
},
"image_alt": {
"type": "string",
"description": "Alt text for the hero image. Required whenever image_url is set."
},
"image_url": {
"type": "string",
"description": "Optional hero image at the top (https URL). For more pictures use image lines in body_md or sections."
}
},
"description": "Content blocks for the template. Check templates_list for the blocks_schema of the template you pick. Never send raw HTML: Hollerpost renders the blocks with the brand header, footer, unsubscribe link and address. The plain template takes no images.",
"additionalProperties": {
"type": "string"
}
},
"survey": {
"anyOf": [
{
"type": "object",
"required": [
"survey_id",
"question_id"
],
"properties": {
"survey_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Survey id (a UUID), as returned by survey_create or surveys_list."
},
"question_id": {
"type": "string",
"minLength": 1,
"description": "Id of one question in that survey. Only rating, nps and single-choice questions (one_click: true) can be answered from an email."
}
},
"description": "Ask one survey question in the email; readers answer with one click. The survey must be open (survey_update with status \"open\") before the campaign can be test-sent or scheduled."
},
{
"type": "null"
}
],
"description": "Set the survey question, or null to remove it."
},
"subject": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "New subject line."
},
"audience": {
"anyOf": [
{
"type": "object",
"required": [
"signup_form_id"
],
"properties": {
"signup_form_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Form UUID from segments_list audiences or page_get. Only confirmed, active, unsuppressed email subscribers from this form, resolved when sending."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"description": "Send to subscribed contacts that have ANY of these tags (one tag is the usual case). Get tags from segments_list."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"all"
],
"properties": {
"all": {
"type": "boolean",
"const": true,
"description": "Send to every subscribed contact in the workspace."
}
},
"additionalProperties": false
}
],
"description": "Who gets it: {\"tags\": [\"vip\"]} for tagged contacts, or {\"all\": true} for every subscribed contact, or {\"signup_form_id\": \"<UUID>\"} for a waitlist."
},
"preheader": {
"type": "string",
"maxLength": 200,
"description": "New preview text."
},
"template_id": {
"type": "string",
"minLength": 1,
"description": "New template id from templates_list."
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"to",
"subject",
"idempotency_key",
"confirm"
],
"properties": {
"to": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Recipient address."
},
"html": {
"type": "string",
"maxLength": 200000,
"description": "HTML body (at most 200,000 characters). Hollerpost adds the brand header."
},
"text": {
"type": "string",
"maxLength": 50000,
"description": "Plain text body (at most 50,000 characters)."
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true, and only after the person explicitly approved this exact recipient, subject and body. Never set it on a guess."
},
"subject": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Subject line."
},
"reply_to": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Reply-to address, if different from the workspace default."
},
"idempotency_key": {
"type": "string",
"maxLength": 200,
"minLength": 8,
"description": "A unique key for this email, for example \"receipt-1042\". Reusing it returns the first result instead of sending again."
}
}
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"mode": {
"enum": [
"waitlist"
],
"type": "string"
},
"show_count": {
"type": "boolean"
},
"launch_note": {
"type": "string",
"maxLength": 500
},
"primary_label": {
"type": "string",
"maxLength": 80,
"description": "Button words when primary_target is page."
},
"primary_target": {
"enum": [
"link",
"page"
],
"type": "string",
"description": "Where the live first button goes: link (primary_link_id) or page (the workspace's Your page, shown only while Your page is published)."
},
"waitlist_pitch": {
"type": "string",
"maxLength": 2000
},
"primary_link_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "An enabled, safe HTTPS page link in this workspace. Live mode needs it unless primary_target is page; null clears it."
},
"waitlist_headline": {
"type": "string",
"maxLength": 120
}
}
}