Peach for WhatsApp Business

Create or upsert multiple contacts in bulk in the Peach account

peach_create_contacts

Create a new Peach pipeline (board) for this account

peach_create_pipeline

Create a new stage in a pipeline

peach_create_pipeline_stage

Create a new guest setup link for WhatsApp onboarding

peach_create_setup_guest_link

Subscribe the connected Shopify store to a webhook topic so Peach receives those notifications (idempotent).

peach_create_shopify_webhook_subscription

Create a new WhatsApp template in the Peach account. Must include at least a body component in components_attributes. Template text uses WhatsApp markdown (*bold*, _italic_, ~strikethrough~, ```monospace```, newlines), NOT HTML/CSS; values containing HTML tags or style attributes are rejected. Placeholders must be named and start with campaign., subscriber. or story., each with a fallback filter, e.g. {{ campaign.order_id | fallback: 'your order' }}; positional ({{1}}) and empty ({{}}) placeholders are rejected, and footers cannot contain placeholders. Read the peach://guides/messaging resource for details.

peach_create_template

Configure a trigger so a Stream automation runs when an event arrives. Choose a condition by its name (the WHEN, e.g. "Order Paid"), supply its variables, and map fields from the event payload into the stream context with JSONPath. The event source is derived automatically. Names come from peach_list_expressions. IMPORTANT: include a `recipient` data-mapping to the contact's phone (e.g. $.subscriber.phone_number for conversation events, $.contact.phone_number for pipeline events) — without a resolved recipient the stream SILENTLY never runs. After creating, dry-run with peach_evaluate_trigger_condition. See the peach://guides/automations resource for per-event payload paths and the custom-topic caveat.

peach_create_trigger

Delete a document from an AI Agent knowledge base and its vector search store.

peach_delete_knowledge_base_document

Delete a media file from the Peach account by its ID

peach_delete_media

Delete a pipeline stage. Fails if the stage still has items or rules.

peach_delete_pipeline_stage

Remove a Shopify webhook subscription for the connected store.

peach_delete_shopify_webhook_subscription

Enroll a contact into a pipeline without sending messages. When allow_re_enrollment is enabled and the contact has a terminal or dropped-off active item, archives the prior round and creates a fresh item (source_data.source_item_id links the prior pli_... id).

peach_enroll_contact_in_pipeline

Expire an existing guest setup link by its numeric id

peach_expire_setup_guest_link

Returns saved account setup properties such as primary goal, communication preferences, and team size.

peach_get_account_setup

Get details of a specific AI Agent by its ID, including system instructions, prompt sections (conversation_prompt, business_context), and connected knowledge bases

peach_get_ai_agent

Get a Stream automation by ID, including its step-graph definition when present

peach_get_automation

Fetch full details for a single broadcast: template, audience, launch configuration, AI agent reply handler, and engagement stats

peach_get_broadcast

Get the status and details of a specific event by its ID

peach_get_event_status

Returns setup progress and pending onboarding steps for the authenticated account (account setup, phone connection, AI agent configuration, campaign activity).

peach_get_onboarding_status

Returns WhatsApp phone setup details, including connection status, connection mode, linked WhatsApp Business Account external ID, and whether AI flows are attached. Use whats_app_business_account_id from here when calling peach_create_template on an account with more than one WhatsApp Business Account.

peach_get_phone_setup_status

Get a pipeline and its stages

peach_get_pipeline

Get a specific WhatsApp template by its ID (wat_…), template_name, or system_name. Response includes system_name for notification automation authoring.

peach_get_template

Create and launch a broadcast campaign to multiple contacts via the Peach API

peach_launch_broadcast

List chronological activities (log) for the account or a specific contact, including messages, status changes, and assignments.

peach_list_activities

List questions asked by autonomous AI agents awaiting human answers (Needs answer queue). Each consultation includes question, status, urgency, contact info, conversation_id, and AI agent info.

peach_list_agent_consultations

List recent real/customer-facing interaction sessions (StreamSessions) for a specific AI Agent. Test sessions are available through peach_list_test_sessions.

peach_list_ai_agent_sessions

List AI Agents (AiFlow) in the Peach account (both autonomous and legacy flows)

peach_list_ai_agents

List Stream automations configured in Peach

peach_list_automations

List broadcast campaigns for the account, with optional filters

peach_list_broadcasts

List WhatsApp Business App (coexistence) numbers linked to this account, with their assignee and synced contact list. Call this first when a question is specifically about Business App DMs. Note this lists only coexistence numbers — the account may also have Cloud API numbers that can be read from and replied on.

peach_list_coexistence_numbers

List conversations for the account. Supports filtering by status, escalation, activity type, business number, and time windows.

peach_list_conversations

List the trigger condition library (expressions). Each expression describes WHEN a trigger fires (e.g. "Order Paid", "Fires on topic") and the variables it needs. Reference one by id when creating a trigger.

peach_list_expressions

List knowledge bases and their indexed documents in the Peach account. Optionally filter by an AI Agent ID.

peach_list_knowledge_bases

List media files uploaded to the Peach account

peach_list_media

List messages in the Peach account with optional filters. Each message includes conversation_id and the contact who sent/received it, so one call is enough to attribute messages to people — do not fetch conversations separately just to identify them. Messages with an attached media file (voice notes, images, videos, documents) include a `media_url` field with a downloadable URL for the attachment.

peach_list_messages

List active items in a pipeline

peach_list_pipeline_items

List active Peach pipelines for this account

peach_list_pipelines

List the Shopify webhook subscriptions currently registered for the connected store.

peach_list_shopify_webhook_subscriptions

List common Shopify webhook topics you can subscribe to (e.g. ORDERS_PAID, ORDERS_FULFILLED).

peach_list_shopify_webhook_topics

List template messages sent via the Peach API with optional filters

peach_list_template_messages