{
"ok": false,
"error": "Invalid or missing API key"
}
{
"ok": false,
"error": "This API key cannot create and edit.",
"required_scope": "write"
}
Suppression
Create a suppression list
Creates a suppression list (name required); add numbers via /entries. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Verbose","colors":{"primary":"#367ef0","light":"#7AA9FF","dark":"#1B1B1F"},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://platform.verbose.cx"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"verbose","hasAudioNarration":false,"actualSubdomain":"verbose","customDomains":["docs.verbose.cx"],"gitSource":{"type":"github","owner":"verbose-inc","repo":"astrasend","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada18e50febba82de309c21","clientVersion":"0.0.4138","searchFilterCounts":[{"language":"default","tag":"API reference","count":89},{"language":"default","tag":"Endpoints","count":89},{"language":"default","tag":"Documentation","count":17},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"10DLC","count":10},{"language":"default","tag":"Numbers","count":9},{"language":"default","tag":"Lists","count":8},{"language":"default","tag":"Segments","count":7},{"language":"default","tag":"Suppression","count":7},{"language":"default","tag":"Agents","count":6}]},"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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/suppression/create-a-suppression-list","slug":"/api-reference/suppression/create-a-suppression-list","pageMetadata":{"title":"Create a suppression list","description":"Creates a suppression list (`name` required); add numbers via `/entries`. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/suppression-lists","href":"/api-reference/suppression/create-a-suppression-list","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a suppression list (\", _jsx(_components.code, {\n children: \"name\"\n }), \" required); add numbers via \", _jsx(_components.code, {\n children: \"/entries\"\n }), \". Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"Create a suppression list","description":"Creates a suppression list (`name` required); add numbers via `/entries`. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/suppression-lists","href":"/api-reference/suppression/create-a-suppression-list","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createSuppressionList","summary":"Create a suppression list","description":"Creates a suppression list (`name` required); add numbers via `/entries`. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.","tags":["Suppression"],"requestBody":"7d65bf82-e6ea-453f-a99c-3269360e29aa","responses":{"200":"88f61a6c-1f64-4331-941a-dfd02a9d1c78","400":"240f7c4d-8058-42b8-b4e0-998770c5d352","401":"2e3902bd-a452-4547-94a5-01cf53bb3f67","403":"ad21379c-878c-4dc7-9739-c3221da0de54"},"method":"post","type":"path","servers":["46c1b261-3cd7-4442-aafc-e66d4629f696"],"security":["14fcfada-387e-4db4-b42e-dad8211b0266"],"path":"/v1/suppression-lists","baseUrlOptions":["https://api.verbose.cx"],"title":"Create a suppression list","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Suppression list name.","example":"Global DNC","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"definition":{"type":"object","description":"Rule set for the audience. Conditions combine within a group by `match` (all = AND, any = OR); groups combine the same way.","properties":{"match":{"type":"string","enum":["all","any"],"default":"all","uniqueKey":"definition.match","typeLabel":"enum\u003cstring>"},"base_lead_list_id":{"oneOf":[{"type":"string","uniqueKey":"definition.base_lead_list_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"definition.base_lead_list_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.base_lead_list_id","typeLabel":"string | null"},"conditions":{"type":"array","items":{"type":"object","required":["field","op","value"],"properties":{"field":{"type":"string","description":"What to test — see the field catalog (e.g. last_clicked, has_tag, total_revenue).","isRequired":true,"uniqueKey":"definition.conditions.items.[INDEX].field","typeLabel":"string"},"op":{"type":"string","description":"The operator for the field's type (gte/lte/eq, within/older, is, contains).","isRequired":true,"uniqueKey":"definition.conditions.items.[INDEX].op","typeLabel":"string"},"value":{"description":"The value to compare against.","isRequired":true,"uniqueKey":"definition.conditions.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"definition.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"definition.conditions","typeLabel":"object[]"},"groups":{"type":"array","items":{"type":"object","properties":{"match":{"type":"string","enum":["all","any"],"uniqueKey":"definition.groups.items.[INDEX].match","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","items":{"type":"object","required":["field","op","value"],"properties":{"field":{"type":"string","description":"What to test — see the field catalog (e.g. last_clicked, has_tag, total_revenue).","isRequired":true,"uniqueKey":"definition.groups.items.[INDEX].conditions.items.[INDEX].field","typeLabel":"string"},"op":{"type":"string","description":"The operator for the field's type (gte/lte/eq, within/older, is, contains).","isRequired":true,"uniqueKey":"definition.groups.items.[INDEX].conditions.items.[INDEX].op","typeLabel":"string"},"value":{"description":"The value to compare against.","isRequired":true,"uniqueKey":"definition.groups.items.[INDEX].conditions.items.[INDEX].value","typeLabel":"any"}},"uniqueKey":"definition.groups.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"definition.groups.items.[INDEX].conditions","typeLabel":"object[]"}},"uniqueKey":"definition.groups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"definition.groups","typeLabel":"object[]"},"created_from":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"definition.created_from.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"definition.created_from.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.created_from","typeLabel":"string\u003cdate-time> | null"},"created_to":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"definition.created_to.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"definition.created_to.oneOf.1","typeLabel":"null"}],"uniqueKey":"definition.created_to","typeLabel":"string\u003cdate-time> | null"}},"example":{"match":"all","groups":[{"match":"all","conditions":[{"field":"last_clicked","op":"within","value":14},{"field":"converted_any","op":"is","value":false}]}]},"uniqueKey":"definition","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Global DNC","definition":{"match":"all","groups":[{"match":"all","conditions":[{"field":"last_clicked","op":"within","value":14},{"field":"converted_any","op":"is","value":false}]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"88f61a6c-1f64-4331-941a-dfd02a9d1c78":{"description":"One suppression list.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":true,"uniqueKey":"ok","typeLabel":"boolean"},"suppression_list":{"type":"object","description":"","additionalProperties":true,"properties":{"id":{"type":"string","uniqueKey":"suppression_list.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"suppression_list.name","typeLabel":"string"},"contact_count":{"type":"integer","uniqueKey":"suppression_list.contact_count","typeLabel":"integer"}},"uniqueKey":"suppression_list","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"suppression_list":{"id":"\u003cstring>","name":"\u003cstring>","contact_count":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"240f7c4d-8058-42b8-b4e0-998770c5d352":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"ok":false,"error":"list_id is required"},"examples":{"Example":{"title":"Example","value":{"ok":false,"error":"list_id is required"}}},"exampleType":"examples"}},"exampleType":"examples"},"2e3902bd-a452-4547-94a5-01cf53bb3f67":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"ok":false,"error":"Invalid or missing API key"},"examples":{"Example":{"title":"Example","value":{"ok":false,"error":"Invalid or missing API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"ad21379c-878c-4dc7-9739-c3221da0de54":{"description":"The API key lacks the scope this action requires (e.g. a read-only key on a write endpoint).","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"ok":false,"error":"This API key cannot create and edit.","required_scope":"write"},"examples":{"Example":{"title":"Example","value":{"ok":false,"error":"This API key cannot create and edit.","required_scope":"write"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"14fcfada-387e-4db4-b42e-dad8211b0266":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key (`as_live_…`), created under Settings → API keys.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"46c1b261-3cd7-4442-aafc-e66d4629f696":{"url":"https://api.verbose.cx","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key (`as_live_…`), created under Settings → API keys.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key (`as_live_…`), created under Settings → API keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"verbose","siteName":"Verbose","title":"Create a suppression list - Verbose","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T14:05:59.727Z","originalFileLocation":"api-reference/suppression/create-a-suppression-list.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=\"description\" content=\"Creates a suppression list (name required); add numbers via /entries. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Verbose\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/verbose/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/verbose/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/verbose/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/verbose/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a suppression list - Verbose\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a suppression list (name required); add numbers via /entries. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Verbose\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://verbose.mintlify.site/_mintlify/api/og/v2?division=Suppression\u0026amp;title=Create+a+suppression+list\u0026amp;description=Creates+a+suppression+list+%28%60name%60+required%29%3B+add+numbers+via+%60%2Fentries%60.+Any+campaign+that+references+it+skips+recipients+on+it+%E2%80%94+the+way+to+honor+do-not-conta\u0026amp;theme=bbb1164994264c82ef7efd4d\u0026amp;signature=a1beb79145f6b1ebd8f2ed46ade5c333ccfc49aab45414236d10bb1a7efddde7\">\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=\"Create a suppression list - Verbose\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a suppression list (name required); add numbers via /entries. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://verbose.mintlify.site/_mintlify/api/og/v2?division=Suppression\u0026amp;title=Create+a+suppression+list\u0026amp;description=Creates+a+suppression+list+%28%60name%60+required%29%3B+add+numbers+via+%60%2Fentries%60.+Any+campaign+that+references+it+skips+recipients+on+it+%E2%80%94+the+way+to+honor+do-not-conta\u0026amp;theme=bbb1164994264c82ef7efd4d\u0026amp;signature=a1beb79145f6b1ebd8f2ed46ade5c333ccfc49aab45414236d10bb1a7efddde7\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/verbose/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Verbose\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#367ef0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/suppression/create-a-suppression-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.verbose.cx/#organization\",\"name\":\"Verbose\",\"url\":\"https://docs.verbose.cx\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.verbose.cx#website\",\"name\":\"Verbose\",\"url\":\"https://docs.verbose.cx\",\"publisher\":{\"@id\":\"https://docs.verbose.cx/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list#webpage\",\"url\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list\",\"name\":\"Create a suppression list\",\"description\":\"Creates a suppression list (name required); add numbers via /entries. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.\",\"dateModified\":\"2026-10-22T14:05:59.727Z\",\"isPartOf\":{\"@id\":\"https://docs.verbose.cx#website\"},\"breadcrumb\":{\"@id\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.verbose.cx/api-reference/general/verify-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Suppression\",\"item\":\"https://docs.verbose.cx/api-reference/suppression/list-suppression-lists\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a suppression list\",\"item\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list#apireference\",\"headline\":\"Create a suppression list\",\"name\":\"Create a suppression list\",\"description\":\"Creates a suppression list (name required); add numbers via /entries. Any campaign that references it skips recipients on it — the way to honor do-not-contact beyond the automatic STOP opt-out.\",\"url\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.verbose.cx/api-reference/suppression/create-a-suppression-list#webpage\"},\"dateModified\":\"2026-10-22T14:05:59.727Z\",\"publisher\":{\"@id\":\"https://docs.verbose.cx/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.verbose.cx#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Verbose\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Verbose\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/suppression/create-a-suppression-list.md","siteName":"Verbose","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"Endpoints","pages":[{"group":"General","pages":[{"title":"Verify key","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/general/verify-key"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create or update contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-or-update-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/contacts/{id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/contacts/{id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Lists","pages":[{"title":"List lists","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/lists","href":"/api-reference/lists/list-lists"},{"title":"Create a list","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/lists","href":"/api-reference/lists/create-a-list"},{"title":"Get a list","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/lists/{id}","href":"/api-reference/lists/get-a-list"},{"title":"Delete a list","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/lists/{id}","href":"/api-reference/lists/delete-a-list"},{"title":"Rename a list","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/lists/{id}","href":"/api-reference/lists/rename-a-list"},{"title":"List members","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/lists/{id}/contacts","href":"/api-reference/lists/list-members"},{"title":"Add members","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/lists/{id}/contacts","href":"/api-reference/lists/add-members"},{"title":"Remove a member","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/lists/{id}/contacts","href":"/api-reference/lists/remove-a-member"}]},{"group":"Segments","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/segments","href":"/api-reference/segments/list-segments"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/segments","href":"/api-reference/segments/create-a-segment"},{"title":"Preview a segment count","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/segments/preview","href":"/api-reference/segments/preview-a-segment-count"},{"title":"Get a segment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/segments/{id}","href":"/api-reference/segments/get-a-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/segments/{id}","href":"/api-reference/segments/delete-a-segment"},{"title":"Update a segment","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/segments/{id}","href":"/api-reference/segments/update-a-segment"},{"title":"List segment members","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/segments/{id}/members","href":"/api-reference/segments/list-segment-members"}]},{"group":"Suppression","pages":[{"title":"List suppression lists","description":"Returns your suppression lists — sets of numbers to keep OFF your sends. Attach one to a campaign to screen its recipients.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/suppression-lists","href":"/api-reference/suppression/list-suppression-lists"},{"title":"Create a suppression list","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/suppression-lists","href":"/api-reference/suppression/create-a-suppression-list"},{"title":"Get a suppression list","description":"Fetches one suppression list and its size.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/suppression-lists/{id}","href":"/api-reference/suppression/get-a-suppression-list"},{"title":"Delete a suppression list","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/suppression-lists/{id}","href":"/api-reference/suppression/delete-a-suppression-list"},{"title":"List entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/suppression-lists/{id}/entries","href":"/api-reference/suppression/list-entries"},{"title":"Add numbers","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/suppression-lists/{id}/entries","href":"/api-reference/suppression/add-numbers"},{"title":"Remove a number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/suppression-lists/{id}/entries","href":"/api-reference/suppression/remove-a-number"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/campaigns/{id}","href":"/api-reference/campaigns/get-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/campaigns/{id}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"Start a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns/{id}/start","href":"/api-reference/campaigns/start-a-campaign"},{"title":"Stop a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/campaigns/{id}/stop","href":"/api-reference/campaigns/stop-a-campaign"}]},{"group":"Messages","pages":[{"title":"Send an SMS","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/messages","href":"/api-reference/messages/send-an-sms"},{"title":"List tracking domains","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/link-domains","href":"/api-reference/messages/list-tracking-domains"}]},{"group":"Calls","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Place an outbound call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/calls","href":"/api-reference/calls/place-an-outbound-call"},{"title":"Get a call","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/calls/{id}","href":"/api-reference/calls/get-a-call"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents/{id}","href":"/api-reference/agents/get-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agents/{id}","href":"/api-reference/agents/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agents/{id}","href":"/api-reference/agents/update-an-agent"},{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/voices","href":"/api-reference/agents/list-voices"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/conversations/{id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Reply in a thread","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/conversations/{id}","href":"/api-reference/conversations/reply-in-a-thread"},{"title":"Set status","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/conversations/{id}","href":"/api-reference/conversations/set-status"}]},{"group":"Numbers","pages":[{"title":"List numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/numbers","href":"/api-reference/numbers/list-numbers"},{"title":"Order a number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/numbers","href":"/api-reference/numbers/order-a-number"},{"title":"Search available numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/numbers/available","href":"/api-reference/numbers/search-available-numbers"},{"title":"Release a number","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/numbers/{id}","href":"/api-reference/numbers/release-a-number"},{"title":"Update a number","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/numbers/{id}","href":"/api-reference/numbers/update-a-number"},{"title":"List pools","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/pools","href":"/api-reference/numbers/list-pools"},{"title":"Create a pool","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/pools","href":"/api-reference/numbers/create-a-pool"},{"title":"Delete a pool","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/pools/{id}","href":"/api-reference/numbers/delete-a-pool"},{"title":"Rename a pool","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/pools/{id}","href":"/api-reference/numbers/rename-a-pool"}]},{"group":"Offers","pages":[{"title":"List offers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/offers","href":"/api-reference/offers/list-offers"},{"title":"Create an offer","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/offers","href":"/api-reference/offers/create-an-offer"},{"title":"Get an offer","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/offers/{id}","href":"/api-reference/offers/get-an-offer"},{"title":"Delete an offer","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/offers/{id}","href":"/api-reference/offers/delete-an-offer"},{"title":"Update an offer","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/offers/{id}","href":"/api-reference/offers/update-an-offer"}]},{"group":"Analytics","pages":[{"title":"Get a report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/analytics/{report}","href":"/api-reference/analytics/get-a-report"},{"title":"Custom report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/analytics/build","href":"/api-reference/analytics/custom-report"}]},{"group":"10DLC","pages":[{"title":"List brands","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tendlc/brands","href":"/api-reference/10dlc/list-brands"},{"title":"Create a brand draft","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tendlc/brands","href":"/api-reference/10dlc/create-a-brand-draft"},{"title":"Get a brand","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tendlc/brands/{id}","href":"/api-reference/10dlc/get-a-brand"},{"title":"Submit a brand","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tendlc/brands/{id}/submit","href":"/api-reference/10dlc/submit-a-brand"},{"title":"Refresh brand status","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tendlc/brands/{id}/refresh","href":"/api-reference/10dlc/refresh-brand-status"},{"title":"List campaign registrations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tendlc/campaigns","href":"/api-reference/10dlc/list-campaign-registrations"},{"title":"Create a campaign draft","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tendlc/campaigns","href":"/api-reference/10dlc/create-a-campaign-draft"},{"title":"Get a campaign registration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tendlc/campaigns/{id}","href":"/api-reference/10dlc/get-a-campaign-registration"},{"title":"Submit a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tendlc/campaigns/{id}/submit","href":"/api-reference/10dlc/submit-a-campaign"},{"title":"Refresh campaign status","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tendlc/campaigns/{id}/refresh","href":"/api-reference/10dlc/refresh-campaign-status"}]},{"group":"Shortcode","pages":[{"title":"List short-code requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shortcode-requests","href":"/api-reference/shortcode/list-short-code-requests"},{"title":"Request a short code","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/shortcode-requests","href":"/api-reference/shortcode/request-a-short-code"}]},{"group":"Flows","pages":[{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/flows","href":"/api-reference/flows/list-flows"},{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/flows","href":"/api-reference/flows/create-a-flow"},{"title":"Get a flow","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/flows/{id}","href":"/api-reference/flows/get-a-flow"},{"title":"Delete a flow","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/flows/{id}","href":"/api-reference/flows/delete-a-flow"},{"title":"Update a flow","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/flows/{id}","href":"/api-reference/flows/update-a-flow"},{"title":"Flow stats","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/flows/{id}/stats","href":"/api-reference/flows/flow-stats"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-event"}]},{"group":"Conversions","pages":[{"title":"Record a conversion","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/conversion","href":"/api-reference/conversions/record-a-conversion"}]}]}]}]},"basePath":"","title":"Create a suppression list - Verbose","buildId":"dpl_715YoAgvjTGBDdo8RtXmHKM22b5p","deploymentId":"dpl_715YoAgvjTGBDdo8RtXmHKM22b5p","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BvKnMd7F.js","utils-BMt52org.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CGXZuDGO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dl57XWH2.js","snippetPresets-CWd8CxSk.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BR-Wkc_D.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-YMmi08aZ.js","shallow-DBC1OB78.js","getApiPlaygroundDisplay-Be7mmEzP.js","CodeSnippet-B14o1TgQ.js","CodeSnippets-CJ2q3fTq.js","Page-Chgj7sZe.js","getPastedJson-DnpLXm8x.js","icon-BpkSFtdK.js","MethodPill-BO3zPf-g.js","DuplicateIcon-Bib3qwfw.js","createIcon-CY2noFo3.js","DynamicMarkdown-TAXIW2vN.js","SectionHeading-Dfs3Fmfw.js","axios-vUo_bRtp.js","Markdown-CGAo_eqA.js","clsx-BNa-H6W6.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-r2tNEC1n.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B7oWe6jc.js"]}