{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ChatBridge","description":"ChatBridge Public REST API — contacts, conversations, messages, templates, tickets, and WhatsApp Flows.","colors":{"primary":"#25D366","light":"#4ADE80","dark":"#0F2340"},"logo":{"light":"https://mintcdn.com/algosmithssoftcom/q59wWso_0E1ON8iS/logo/light.webp?fit=max\u0026auto=format\u0026n=q59wWso_0E1ON8iS\u0026q=85\u0026s=9d707b2e25eb1a936f0c2559572856a7","dark":"https://mintcdn.com/algosmithssoftcom/q59wWso_0E1ON8iS/logo/dark.webp?fit=max\u0026auto=format\u0026n=q59wWso_0E1ON8iS\u0026q=85\u0026s=02a10d4f7f56ad453ed72d49c6553103"},"favicon":"https://mintcdn.com/algosmithssoftcom/q59wWso_0E1ON8iS/favicon.png?fit=max\u0026auto=format\u0026n=q59wWso_0E1ON8iS\u0026q=85\u0026s=f7e5edf0fdc1c1ddc6c820024140552c","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://chatbridge.algosmiths.com","label":"Dashboard"}]},"footer":{"socials":{"website":"https://chatbridge.algosmiths.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"algosmithssoftcom","hasAudioNarration":false,"actualSubdomain":"algosmithssoftcom","customDomains":["docs.chatbridge.algosmiths.com"],"gitSource":{"type":"github","owner":"algosmiths-softcom","repo":"whatsconnect","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6abb4f5ed0c82aa0ccb84753","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":58},{"language":"default","tag":"Tickets","count":10},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Get Started","count":9},{"language":"default","tag":"Contacts","count":8},{"language":"default","tag":"Broadcasts","count":7},{"language":"default","tag":"Custom Fields","count":5},{"language":"default","tag":"Ticket Pipelines","count":5},{"language":"default","tag":"Ticket Stages","count":5},{"language":"default","tag":"Flows","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/macros/run-a-macro-against-a-conversation-or-ticket","slug":"/api-reference/macros/run-a-macro-against-a-conversation-or-ticket","pageMetadata":{"title":"Run a macro against a conversation or ticket","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/macros/{id}/run/","href":"/api-reference/macros/run-a-macro-against-a-conversation-or-ticket","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run a macro against a conversation or ticket","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/macros/{id}/run/","href":"/api-reference/macros/run-a-macro-against-a-conversation-or-ticket","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"runMacro","summary":"Run a macro against a conversation or ticket","parameters":["35bbd9d0-d14b-4bdb-a76b-f29040ba455d"],"tags":["Macros"],"requestBody":"ba74bc0f-d39d-4ded-9f5e-3f9b5c20c71a","security":["d83ff97d-960b-4b2c-a34e-9e3056674f23","d7491c75-a61e-4505-aded-ebb49aa267bd","db8afa0b-fc46-45c8-9895-00440890b330"],"responses":{"200":"39ad17c5-4e7a-4787-a0a5-3df85a0c9cc0","400":"fd78a9fc-65bb-497a-bb15-cbf0bc717b81","401":"6a46cf3f-6c71-453a-828a-dd6f5bef41e8","403":"8ca8d9fb-0579-43fa-a8ee-c620620b0695","404":"4ea555c2-f54c-4f0a-b6ee-2833838c701e","429":"ff43527f-427d-463a-a9c4-40c98b5e25dd"},"method":"post","type":"path","servers":["87340855-62a9-44d7-8ad9-1813baec6808"],"path":"/api/v1/macros/{id}/run/","baseUrlOptions":["https://api.algosmiths.com"],"title":"Run a macro against a conversation or ticket","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"35bbd9d0-d14b-4bdb-a76b-f29040ba455d":{"in":"path","name":"id","schema":{"type":"integer","isRequired":true,"uniqueKey":"","typeLabel":"integer"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"chat_id":{"type":"integer","uniqueKey":"chat_id","typeLabel":"integer"},"ticket_id":{"type":"integer","uniqueKey":"ticket_id","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"chat_id":123,"ticket_id":123}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"chat_id":{"type":"integer","uniqueKey":"chat_id","typeLabel":"integer"},"ticket_id":{"type":"integer","uniqueKey":"ticket_id","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"chat_id":123,"ticket_id":123}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"chat_id":{"type":"integer","uniqueKey":"chat_id","typeLabel":"integer"},"ticket_id":{"type":"integer","uniqueKey":"ticket_id","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"chat_id":123,"ticket_id":123}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"39ad17c5-4e7a-4787-a0a5-3df85a0c9cc0":{"content":{"application/json":{"schema":{"type":"object","properties":{"ran":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"ran.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"ran.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"ran","typeLabel":"object[]"}},"required":["ran"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ran":[{}]}}},"exampleType":"generated"}},"description":"","exampleType":"generated"},"fd78a9fc-65bb-497a-bb15-cbf0bc717b81":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"additionalProperties","typeLabel":"string[]"},"description":"Field-level validation error response (400). Keys are field names; values are lists of error messages. May include 'non_field_errors' for non-field-specific errors.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"description":"Bad Request — validation error","exampleType":"generated"},"6a46cf3f-6c71-453a-828a-dd6f5bef41e8":{"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Unauthorized — missing or invalid API key","exampleType":"generated"},"8ca8d9fb-0579-43fa-a8ee-c620620b0695":{"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Forbidden — API key lacks the `macro.view` scope, or lacks the underlying scope of an action in the macro (a macro is a shortcut, never a scope escalation)","exampleType":"generated"},"4ea555c2-f54c-4f0a-b6ee-2833838c701e":{"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not Found","exampleType":"generated"},"ff43527f-427d-463a-a9c4-40c98b5e25dd":{"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Too Many Requests — rate limit exceeded (60 requests/minute per key)","exampleType":"generated"}},"security":{"d83ff97d-960b-4b2c-a34e-9e3056674f23":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"cb_...","description":"Workspace API key, e.g. `Authorization: Bearer cb_live_...`. Create one in Settings → API Keys. See public_api.md § 3 for scopes.","scopes":[]}},"d7491c75-a61e-4505-aded-ebb49aa267bd":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\"","scopes":[]}},"db8afa0b-fc46-45c8-9895-00440890b330":{"CookieAuth":{"type":"apiKey","in":"cookie","name":"token","description":"Dashboard session cookie — internal use only, not the public contract.","scopes":[]}}},"servers":{"87340855-62a9-44d7-8ad9-1813baec6808":{"url":"https://api.algosmiths.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"cb_...","description":"Workspace API key, e.g. `Authorization: Bearer cb_live_...`. Create one in Settings → API Keys. See public_api.md § 3 for scopes.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Workspace API key, e.g. `Authorization: Bearer cb_live_...`. Create one in Settings → API Keys. See public_api.md § 3 for scopes.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Token-based authentication with required prefix \"Token\"","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Token-based authentication with required prefix \"Token\"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"tokenAuth","name":"Authorization"}],"title":"tokenAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"token","description":"Dashboard session cookie — internal use only, not the public contract.","scopes":[]},"schema":{"title":"token","type":"string","description":"Dashboard session cookie — internal use only, not the public contract.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"CookieAuth","name":"token"}],"title":"CookieAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"algosmithssoftcom","siteName":"ChatBridge","title":"Run a macro against a conversation or ticket - ChatBridge","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T05:40:50.320Z","originalFileLocation":"api-reference/macros/run-a-macro-against-a-conversation-or-ticket.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"ChatBridge\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run a macro against a conversation or ticket - ChatBridge\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ChatBridge\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://algosmithssoftcom.mintlify.site/_mintlify/api/og/v2?division=Macros\u0026amp;title=Run+a+macro+against+a+conversation+or+ticket\u0026amp;theme=6d496d433348106e519d404e\u0026amp;signature=aa8e8bb4da4b8a3b52cbc37d3e6e51e24b0b213d90bd5a3eb2676d9c7cdd9864\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run a macro against a conversation or ticket - ChatBridge\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://algosmithssoftcom.mintlify.site/_mintlify/api/og/v2?division=Macros\u0026amp;title=Run+a+macro+against+a+conversation+or+ticket\u0026amp;theme=6d496d433348106e519d404e\u0026amp;signature=aa8e8bb4da4b8a3b52cbc37d3e6e51e24b0b213d90bd5a3eb2676d9c7cdd9864\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/algosmithssoftcom/7doyscT2WZhBOfHO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ChatBridge\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#25D366\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/macros/run-a-macro-against-a-conversation-or-ticket.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chatbridge.algosmiths.com/#organization\",\"name\":\"ChatBridge\",\"url\":\"https://docs.chatbridge.algosmiths.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/algosmithssoftcom/q59wWso_0E1ON8iS/logo/light.webp?fit=max\u0026auto=format\u0026n=q59wWso_0E1ON8iS\u0026q=85\u0026s=9d707b2e25eb1a936f0c2559572856a7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chatbridge.algosmiths.com#website\",\"name\":\"ChatBridge\",\"url\":\"https://docs.chatbridge.algosmiths.com\",\"publisher\":{\"@id\":\"https://docs.chatbridge.algosmiths.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket#webpage\",\"url\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket\",\"name\":\"Run a macro against a conversation or ticket\",\"dateModified\":\"2026-09-29T05:40:50.320Z\",\"isPartOf\":{\"@id\":\"https://docs.chatbridge.algosmiths.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Macros\",\"item\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/list-macros\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run a macro against a conversation or ticket\",\"item\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket#apireference\",\"headline\":\"Run a macro against a conversation or ticket\",\"name\":\"Run a macro against a conversation or ticket\",\"url\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chatbridge.algosmiths.com/api-reference/macros/run-a-macro-against-a-conversation-or-ticket#webpage\"},\"dateModified\":\"2026-09-29T05:40:50.320Z\",\"publisher\":{\"@id\":\"https://docs.chatbridge.algosmiths.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chatbridge.algosmiths.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ChatBridge\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ChatBridge\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/macros/run-a-macro-against-a-conversation-or-ticket.md","siteName":"ChatBridge","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference"}]},{"group":"Broadcasts","pages":[{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/broadcasts/","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Create a broadcast draft","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/broadcasts/","href":"/api-reference/broadcasts/create-a-broadcast-draft"},{"title":"Preview recipient count for a broadcast filter","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/broadcasts/preview/","href":"/api-reference/broadcasts/preview-recipient-count-for-a-broadcast-filter"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/broadcasts/{id}/","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"Discard a draft broadcast","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/broadcasts/{id}/","href":"/api-reference/broadcasts/discard-a-draft-broadcast"},{"title":"Confirm and send a draft broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/broadcasts/{id}/confirm/","href":"/api-reference/broadcasts/confirm-and-send-a-draft-broadcast"},{"title":"Unschedule a scheduled broadcast","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/broadcasts/{id}/unschedule/","href":"/api-reference/broadcasts/unschedule-a-scheduled-broadcast"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contacts/","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/contacts/","href":"/api-reference/contacts/create-a-contact"},{"title":"Bulk import contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/contacts/bulk/","href":"/api-reference/contacts/bulk-import-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contacts/{receiver_id}/","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/contacts/{receiver_id}/","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/contacts/{receiver_id}/","href":"/api-reference/contacts/delete-a-contact"},{"title":"List notes on a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/contacts/{receiver_id}/notes/","href":"/api-reference/contacts/list-notes-on-a-contact"},{"title":"Add a note to a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/contacts/{receiver_id}/notes/","href":"/api-reference/contacts/add-a-note-to-a-contact"}]},{"group":"Custom Fields","pages":[{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/custom-fields/","href":"/api-reference/custom-fields/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/custom-fields/","href":"/api-reference/custom-fields/create-a-custom-field-definition"},{"title":"Get a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/custom-fields/{id}/","href":"/api-reference/custom-fields/get-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/custom-fields/{id}/","href":"/api-reference/custom-fields/update-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/custom-fields/{id}/","href":"/api-reference/custom-fields/delete-a-custom-field-definition"}]},{"group":"Conversations","pages":[{"title":"List conversations (latest message per contact)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/conversations/","href":"/api-reference/conversations/list-conversations-latest-message-per-contact"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/conversations/{receiver_id}/messages/","href":"/api-reference/conversations/list-messages-in-a-conversation"},{"title":"Update conversation status/priority/tags or reassign","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/conversations/{receiver_id}/","href":"/api-reference/conversations/update-conversation-statusprioritytags-or-reassign"}]},{"group":"Messages","pages":[{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/messages/","href":"/api-reference/messages/send-a-whatsapp-message"}]},{"group":"Templates","pages":[{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/templates/","href":"/api-reference/templates/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/templates/","href":"/api-reference/templates/create-a-message-template"}]},{"group":"Macros","pages":[{"title":"List macros","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/macros/","href":"/api-reference/macros/list-macros"},{"title":"Run a macro against a conversation or ticket","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/macros/{id}/run/","href":"/api-reference/macros/run-a-macro-against-a-conversation-or-ticket"}]},{"group":"Team","pages":[{"title":"List team members","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/team/members/","href":"/api-reference/team/list-team-members"},{"title":"List team inboxes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/team/inboxes/","href":"/api-reference/team/list-team-inboxes"}]},{"group":"Catalogue","pages":[{"title":"List catalogue products (live Meta proxy)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalogue/products/","href":"/api-reference/catalogue/list-catalogue-products-live-meta-proxy"}]},{"group":"Account Health","pages":[{"title":"Aggregated account health (phone quality, template quality, recent alerts)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/account-health/","href":"/api-reference/account-health/aggregated-account-health-phone-quality-template-quality-recent-alerts"},{"title":"List phone numbers connected to this workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/phone-numbers/","href":"/api-reference/account-health/list-phone-numbers-connected-to-this-workspace"}]},{"group":"Tickets","pages":[{"title":"List tickets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/tickets/","href":"/api-reference/tickets/list-tickets"},{"title":"Create a ticket","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tickets/","href":"/api-reference/tickets/create-a-ticket"},{"title":"Get a ticket","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/tickets/{id}/","href":"/api-reference/tickets/get-a-ticket"},{"title":"Update a ticket","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/tickets/{id}/","href":"/api-reference/tickets/update-a-ticket"},{"title":"Delete a ticket","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/tickets/{id}/","href":"/api-reference/tickets/delete-a-ticket"},{"title":"List comments on a ticket","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/tickets/{ticket_id}/comments/","href":"/api-reference/tickets/list-comments-on-a-ticket"},{"title":"Add a comment to a ticket","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tickets/{ticket_id}/comments/","href":"/api-reference/tickets/add-a-comment-to-a-ticket"},{"title":"Get a ticket's audit log","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/tickets/{ticket_id}/activity/","href":"/api-reference/tickets/get-a-tickets-audit-log"},{"title":"Escalate a ticket to a different agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tickets/{ticket_id}/escalate/","href":"/api-reference/tickets/escalate-a-ticket-to-a-different-agent"},{"title":"Mark a ticket as a duplicate of another, closing it","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/tickets/{ticket_id}/merge/","href":"/api-reference/tickets/mark-a-ticket-as-a-duplicate-of-another-closing-it"}]},{"group":"Ticket Pipelines","pages":[{"title":"List ticket pipelines","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ticket-pipelines/","href":"/api-reference/ticket-pipelines/list-ticket-pipelines"},{"title":"Create a ticket pipeline","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/ticket-pipelines/","href":"/api-reference/ticket-pipelines/create-a-ticket-pipeline"},{"title":"Get a ticket pipeline","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ticket-pipelines/{id}/","href":"/api-reference/ticket-pipelines/get-a-ticket-pipeline"},{"title":"Update a ticket pipeline","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/ticket-pipelines/{id}/","href":"/api-reference/ticket-pipelines/update-a-ticket-pipeline"},{"title":"Delete a ticket pipeline","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/ticket-pipelines/{id}/","href":"/api-reference/ticket-pipelines/delete-a-ticket-pipeline"}]},{"group":"Ticket Stages","pages":[{"title":"List stages in a pipeline","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/ticket-pipelines/{pipeline_id}/stages/","href":"/api-reference/ticket-stages/list-stages-in-a-pipeline"},{"title":"Create a stage in a pipeline","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/ticket-pipelines/{pipeline_id}/stages/","href":"/api-reference/ticket-stages/create-a-stage-in-a-pipeline"},{"title":"Update a stage","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/ticket-pipelines/{pipeline_id}/stages/{stage_id}/","href":"/api-reference/ticket-stages/update-a-stage"},{"title":"Delete a stage","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/ticket-pipelines/{pipeline_id}/stages/{stage_id}/","href":"/api-reference/ticket-stages/delete-a-stage"},{"title":"Reorder stages in a pipeline","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/ticket-pipelines/{pipeline_id}/stages/reorder/","href":"/api-reference/ticket-stages/reorder-stages-in-a-pipeline"}]},{"group":"Flows","pages":[{"title":"List WhatsApp Flows (live Meta sync)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/flows/","href":"/api-reference/flows/list-whatsapp-flows-live-meta-sync"},{"title":"Get a Flow (live Meta re-sync)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/flows/{flow_id}/","href":"/api-reference/flows/get-a-flow-live-meta-re-sync"},{"title":"Get endpoint metrics for a Data Exchange Flow","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/flows/{flow_id}/metrics/","href":"/api-reference/flows/get-endpoint-metrics-for-a-data-exchange-flow"},{"title":"List submissions for a Flow","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/flows/{flow_id}/submissions/","href":"/api-reference/flows/list-submissions-for-a-flow"}]}]}]},"basePath":"","title":"Run a macro against a conversation or ticket - ChatBridge","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}