email.suppressed. A recipient was refused by the suppression list, at accept or at send; data.suppressed says why. It is sent beside email.failed with recipient_suppressed: handle one of them. Sent to the application’s webhook. A message of several recipients sends one per recipient, its data adding recipient and tags after to. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks’ webhook-signature with its whsec_ secret (recommended there); otherwise tawked-signature with the webhook secret, and make handling idempotent on tawked-webhook-id: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.
Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes verify:check, verify:send (includes verify:check), notifications:read, notifications:send (includes notifications:read), email:read, email:send (includes email:read), email:manage (includes email:send), webhooks:manage, email:inbound, notifications:templates (includes notifications:read), chat:menus, chat:attendant. No key made on the API keys page holds notifications:templates, full access included: the three template writes answer such a key 403 insufficient_scope. A connected app's key holds it. Nor chat:menus: the five conversation menu operations answer such a key 403 insufficient_scope, and a connected app's key holds it once the client approved it. Nor chat:attendant: the five auto-attendant operations answer such a key 403 insufficient_scope too, and a connected app's key holds it once the client approved it. email:manage and webhooks:manage are held only by a key someone chose them for: a full-access key, old or new, never holds them. email:inbound, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 insufficient_scope and names the scope it needs in the WWW-Authenticate response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.
Standard Webhooks, sent when the endpoint's Standard signing is on: v1,<base64> of HMAC-SHA256 of "{webhook-id}.{webhook-timestamp}.{raw body}" with the base64-decoded part of your whsec_ secret; during a rotation's grace a space and the previous secret's signature follow.
true on a console test event and on Tawked's test message to a new receiving address; never on a customer's event.
Response
200
Any 2xx answer within 5 seconds acknowledges the delivery. Anything else, a redirect or no answer in time is retried: 5 attempts in all, the first at once and the next after 1 min, 5 min, 30 min, 2 h.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tawked","description":"Tawked developer docs: one-time codes by SMS with Tawked Verify, WhatsApp template messages from your own number with Tawked Notifications, replies in Tawked Chat, transactional e-mail from your own domain with Tawked Email, the Partner API for platforms, and the store integrations.","colors":{"primary":"#2563EB","light":"#60A5FA","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/logo/light.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=353a0cedb91848c1296f205d3552fcca","dark":"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/logo/dark.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=55027020324a6f5ac4b2608dbd1f8b9f","href":"https://tawked.com"},"favicon":"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/favicon.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=a021d3b38b58bccc6b7b81a1b83946ee","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","php","python"]}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://tawked.com/en/contact","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://tawked.com/en/login"}},"footer":{"socials":{"x":"https://x.com/tawkeds"},"links":[{"header":"Products","items":[{"label":"Tawked Verify","href":"https://tawked.com/en/verify"},{"label":"Tawked Notifications","href":"https://tawked.com/en/whatsapp"},{"label":"Tawked Chat","href":"https://tawked.com/en/chat"},{"label":"The Salla app","href":"https://tawked.com/en/salla"},{"label":"Pricing","href":"https://tawked.com/en/pricing"},{"label":"Status","href":"https://tawked.com/en/status"}]},{"header":"Machine-readable","items":[{"label":"OpenAPI","href":"https://tawked.com/openapi.json"},{"label":"Docs MCP server","href":"https://docs.tawked.com/agents"},{"label":"llms.txt","href":"https://docs.tawked.com/llms.txt"},{"label":"skill.md","href":"https://docs.tawked.com/skill.md"},{"label":"Changelog RSS","href":"https://docs.tawked.com/changelog/rss.xml"}]},{"header":"Legal","items":[{"label":"Terms","href":"https://tawked.com/en/terms"},{"label":"Privacy","href":"https://tawked.com/en/privacy"}]}]},"search":{"prompt":"Search the Tawked docs"},"seo":{"metatags":{"og:site_name":"Tawked developer docs","og:image":"https://tawked.com/og/developer-docs-en.png?v=27df06570d","og:image:type":"image/png","og:image:width":"1200","og:image:height":"630","og:image:alt":"Tawked developer docs. Verify, WhatsApp, Chat, Email and the Account API","twitter:card":"summary_large_image","twitter:image":"https://tawked.com/og/developer-docs-en.png?v=27df06570d"},"indexing":"all"},"fonts":{"family":"Figtree"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"errors":{"404":{"redirect":false,"title":"This page is not here","description":"It may have moved. Search the docs, or start from the [overview](/)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode","download-spec"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"signal","href":"https://tawked.com/en/status"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tawked","hasAudioNarration":false,"actualSubdomain":"tawked","customDomains":["docs.tawked.com"],"gitSource":{"type":"github","owner":"snoker87","repo":"tawked","deployBranch":"main","contentDirectory":"docs/site","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae5f6a33d1d28d235826841","collectionId":"74a8b83d-8b94-48ed-a3c2-0f61e1eabb41","liveDeploymentHistoryId":"6ae5f6a33d1d28d235826841","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae5f6a33d1d28d235826841","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Account API","count":413},{"language":"default","tag":"Operations","count":403},{"language":"default","tag":"API reference","count":133},{"language":"default","tag":"radeef","count":65},{"language":"default","tag":"email","count":58},{"language":"default","tag":"Email","count":53},{"language":"default","tag":"Webhooks","count":50},{"language":"default","tag":"Guides","count":44},{"language":"default","tag":"whatsapp","count":43},{"language":"default","tag":"campaigns","count":32}]},"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":"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","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}],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--tawked-radius:0.75rem}.callout,.card,.code-block,[class*=card],pre{border-radius:var(--tawked-radius)}code:not(pre code){font-size:.9em}.method-pill,[class*=method]>span{border-radius:9999px}table td:first-child,table th:first-child{white-space:nowrap;width:1%}table td code{white-space:nowrap}"}],"page":{"pagePath":"api-reference/webhooks/email-suppressed","slug":"/api-reference/webhooks/email-suppressed","pageMetadata":{"title":"Email suppressed","description":"`email.suppressed`. A recipient was refused by the suppression list, at accept or at send; `data.suppressed` says why. It is sent beside `email.failed` with `recipient_suppressed`: handle one of them. Sent to the application's webhook. A message of several recipients sends one per recipient, its `data` adding `recipient` and `tags` after `to`. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks' `webhook-signature` with its `whsec_` secret (recommended there); otherwise `tawked-signature` with the webhook secret, and make handling idempotent on `tawked-webhook-id`: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.suppressed","href":"/api-reference/webhooks/email-suppressed","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: [_jsx(_components.code, {\n children: \"email.suppressed\"\n }), \". A recipient was refused by the suppression list, at accept or at send; \", _jsx(_components.code, {\n children: \"data.suppressed\"\n }), \" says why. It is sent beside \", _jsx(_components.code, {\n children: \"email.failed\"\n }), \" with \", _jsx(_components.code, {\n children: \"recipient_suppressed\"\n }), \": handle one of them. Sent to the application’s webhook. A message of several recipients sends one per recipient, its \", _jsx(_components.code, {\n children: \"data\"\n }), \" adding \", _jsx(_components.code, {\n children: \"recipient\"\n }), \" and \", _jsx(_components.code, {\n children: \"tags\"\n }), \" after \", _jsx(_components.code, {\n children: \"to\"\n }), \". Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks’ \", _jsx(_components.code, {\n children: \"webhook-signature\"\n }), \" with its \", _jsx(_components.code, {\n children: \"whsec_\"\n }), \" secret (recommended there); otherwise \", _jsx(_components.code, {\n children: \"tawked-signature\"\n }), \" with the webhook secret, and make handling idempotent on \", _jsx(_components.code, {\n children: \"tawked-webhook-id\"\n }), \": a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Guide: `,_jsx(_components.a,{href:`/webhooks`,children:`Webhooks`})]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Email suppressed","description":"`email.suppressed`. A recipient was refused by the suppression list, at accept or at send; `data.suppressed` says why. It is sent beside `email.failed` with `recipient_suppressed`: handle one of them. Sent to the application's webhook. A message of several recipients sends one per recipient, its `data` adding `recipient` and `tags` after `to`. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks' `webhook-signature` with its `whsec_` secret (recommended there); otherwise `tawked-signature` with the webhook secret, and make handling idempotent on `tawked-webhook-id`: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.suppressed","href":"/api-reference/webhooks/email-suppressed","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Webhooks"],"operationId":"webhook_email_suppressed","summary":"Email suppressed","description":"`email.suppressed`. A recipient was refused by the suppression list, at accept or at send; `data.suppressed` says why. It is sent beside `email.failed` with `recipient_suppressed`: handle one of them. Sent to the application's webhook. A message of several recipients sends one per recipient, its `data` adding `recipient` and `tags` after `to`. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks' `webhook-signature` with its `whsec_` secret (recommended there); otherwise `tawked-signature` with the webhook secret, and make handling idempotent on `tawked-webhook-id`: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.","parameters":["f7cf5c9c-4f9d-42f8-a766-835f6750c220","7eb5aa21-dbc4-4de6-a9df-0cf163772c4b","1e520944-1a1f-4967-b765-68e42e675fe7","c39457ea-55be-4f55-b3bf-8536610d4b19","bb121e93-24f2-4828-9616-87a98335e894","32de800a-a6a9-438b-8677-b0fa8559ff29","eef1a5fe-f870-4c6e-8be5-25744aa3e4c0"],"requestBody":"68e5bde7-f436-47e0-bbd7-e165228cb41c","x-mint":{"content":"Guide: [Webhooks](/webhooks)"},"responses":{"200":"aa94f1ce-6ede-403a-bd82-1e821763adef"},"method":"post","type":"webhook","servers":["098b5cff-a5a4-40d5-a09c-d4f2de097e74","8e6ac1df-d7eb-4814-92be-cac11ef83826"],"security":["f1a99a99-6a6a-42b3-93ac-e626d326e9e6","fe7bec02-0049-4146-a16f-86fd192472c9"],"path":"email.suppressed","baseUrlOptions":["https://tawked.com","https://tawked.com/api"],"title":"Email suppressed","codeSamples":[],"requestExampleLanguages":["bash","javascript","php","python"],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"Example","code":"{\n \"event\": \"email.suppressed\",\n \"data\": {\n \"id\": \"0199f1c2-7a41-7c3e-9d2b-5e8f1a2b3c4d\",\n \"status\": \"failed\",\n \"application_id\": \"c2a10f3e-8b7a-4d2e-9c1a-1a2b3c4d5e6f\",\n \"from\": {\n \"name\": \"متجر أكمي\",\n \"address\": \"orders@acme.sa\"\n },\n \"to\": \"sara@example.com\",\n \"recipient\": {\n \"id\": \"0199f1c2-7a42-7b10-8c3d-2a3b4c5d6e7f\",\n \"address\": \"sara@example.com\",\n \"type\": \"to\",\n \"status\": \"suppressed\"\n },\n \"tags\": [\n {\n \"name\": \"category\",\n \"value\": \"order\"\n }\n ],\n \"mode\": \"live\",\n \"template\": {\n \"id\": \"0199f1f0-2d3e-7f4a-8b5c-6d7e8f9a0b12\",\n \"alias\": \"order-shipped\",\n \"version\": 3\n },\n \"subject\": \"طلبك 1042 في الطريق\",\n \"reference\": \"order-1042\",\n \"price_halalas\": 0,\n \"error\": null,\n \"bounce\": null,\n \"occurred_at\": \"2026-10-23T09:00:03.512Z\",\n \"created_at\": \"2026-10-23T09:00:01.087Z\",\n \"suppressed\": {\n \"reason\": \"bounce\",\n \"by\": \"tawked\"\n }\n },\n \"type\": \"email.suppressed\",\n \"timestamp\": \"2026-10-09T09:00:03.512Z\",\n \"sent_at\": \"1791536403601\"\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"f7cf5c9c-4f9d-42f8-a766-835f6750c220":{"name":"tawked-timestamp","in":"header","required":true,"description":"Milliseconds since the epoch, as a string; the same value as `sent_at`.","schema":{"type":"string","isRequired":true,"description":"Milliseconds since the epoch, as a string; the same value as `sent_at`.","uniqueKey":"","typeLabel":"string"}},"7eb5aa21-dbc4-4de6-a9df-0cf163772c4b":{"name":"tawked-signature","in":"header","required":true,"description":"Hex HMAC-SHA256 of `\"{timestamp}.{raw body}\"` with your webhook secret.","schema":{"type":"string","isRequired":true,"description":"Hex HMAC-SHA256 of `\"{timestamp}.{raw body}\"` with your webhook secret.","uniqueKey":"","typeLabel":"string"}},"1e520944-1a1f-4967-b765-68e42e675fe7":{"name":"tawked-event","in":"header","required":true,"description":"The event name, the same as `event` in the body.","schema":{"type":"string","enum":["email.suppressed"],"isRequired":true,"description":"The event name, the same as `event` in the body.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"c39457ea-55be-4f55-b3bf-8536610d4b19":{"name":"tawked-webhook-id","in":"header","required":true,"description":"The event's id, the same on every retry and on a delivery sent again from the console: dedupe on it.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The event's id, the same on every retry and on a delivery sent again from the console: dedupe on it.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"bb121e93-24f2-4828-9616-87a98335e894":{"name":"webhook-id","in":"header","required":false,"description":"Standard Webhooks, sent when the endpoint's Standard signing is on: the same as `tawked-webhook-id`.","schema":{"type":"string","isRequired":false,"description":"Standard Webhooks, sent when the endpoint's Standard signing is on: the same as `tawked-webhook-id`.","uniqueKey":"","typeLabel":"string"}},"32de800a-a6a9-438b-8677-b0fa8559ff29":{"name":"webhook-timestamp","in":"header","required":false,"description":"Standard Webhooks, sent when the endpoint's Standard signing is on: the same instant as `tawked-timestamp`, in seconds.","schema":{"type":"string","isRequired":false,"description":"Standard Webhooks, sent when the endpoint's Standard signing is on: the same instant as `tawked-timestamp`, in seconds.","uniqueKey":"","typeLabel":"string"}},"eef1a5fe-f870-4c6e-8be5-25744aa3e4c0":{"name":"webhook-signature","in":"header","required":false,"description":"Standard Webhooks, sent when the endpoint's Standard signing is on: `v1,\u003cbase64>` of HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with the base64-decoded part of your `whsec_` secret; during a rotation's grace a space and the previous secret's signature follow.","schema":{"type":"string","isRequired":false,"description":"Standard Webhooks, sent when the endpoint's Standard signing is on: `v1,\u003cbase64>` of HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with the base64-decoded part of your `whsec_` secret; during a rotation's grace a space and the previous secret's signature follow.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"event":{"type":"string","uniqueKey":"event","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.id","typeLabel":"string"},"status":{"type":"string","uniqueKey":"data.status","typeLabel":"string"},"application_id":{"type":"string","uniqueKey":"data.application_id","typeLabel":"string"},"from":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"data.from.name","typeLabel":"string"},"address":{"type":"string","uniqueKey":"data.from.address","typeLabel":"string"}},"uniqueKey":"data.from","typeLabel":"object"},"to":{"type":"string","uniqueKey":"data.to","typeLabel":"string"},"recipient":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.recipient.id","typeLabel":"string"},"address":{"type":"string","uniqueKey":"data.recipient.address","typeLabel":"string"},"type":{"type":"string","uniqueKey":"data.recipient.type","typeLabel":"string"},"status":{"type":"string","uniqueKey":"data.recipient.status","typeLabel":"string"}},"uniqueKey":"data.recipient","typeLabel":"object"},"tags":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"data.tags.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","uniqueKey":"data.tags.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"data.tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.tags","typeLabel":"object[]"},"mode":{"type":"string","uniqueKey":"data.mode","typeLabel":"string"},"template":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.template.id","typeLabel":"string"},"alias":{"type":"string","uniqueKey":"data.template.alias","typeLabel":"string"},"version":{"type":"integer","uniqueKey":"data.template.version","typeLabel":"integer"}},"uniqueKey":"data.template","typeLabel":"object"},"subject":{"type":"string","uniqueKey":"data.subject","typeLabel":"string"},"reference":{"type":"string","uniqueKey":"data.reference","typeLabel":"string"},"price_halalas":{"type":"integer","uniqueKey":"data.price_halalas","typeLabel":"integer"},"error":{"oneOf":[{"type":"string","uniqueKey":"data.error.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.error","typeLabel":"string | null"},"bounce":{"oneOf":[{"type":"string","uniqueKey":"data.bounce.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.bounce.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bounce","typeLabel":"string | null"},"occurred_at":{"type":"string","format":"date-time","uniqueKey":"data.occurred_at","typeLabel":"string\u003cdate-time>"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"suppressed":{"type":"object","properties":{"reason":{"type":"string","uniqueKey":"data.suppressed.reason","typeLabel":"string"},"by":{"type":"string","uniqueKey":"data.suppressed.by","typeLabel":"string"}},"uniqueKey":"data.suppressed","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"sent_at":{"type":"string","uniqueKey":"sent_at","typeLabel":"string"},"mode":{"type":"string","enum":["test"],"description":"On a test key's event only (simulated: nothing was sent or received). On `email.received` it is the only sign of a simulated e-mail.","uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"test":{"type":"boolean","const":true,"description":"`true` on a console test event and on Tawked's test message to a new receiving address; never on a customer's event.","uniqueKey":"test","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"event":"email.suppressed","data":{"id":"0199f1c2-7a41-7c3e-9d2b-5e8f1a2b3c4d","status":"failed","application_id":"c2a10f3e-8b7a-4d2e-9c1a-1a2b3c4d5e6f","from":{"name":"متجر أكمي","address":"orders@acme.sa"},"to":"sara@example.com","recipient":{"id":"0199f1c2-7a42-7b10-8c3d-2a3b4c5d6e7f","address":"sara@example.com","type":"to","status":"suppressed"},"tags":[{"name":"category","value":"order"}],"mode":"live","template":{"id":"0199f1f0-2d3e-7f4a-8b5c-6d7e8f9a0b12","alias":"order-shipped","version":3},"subject":"طلبك 1042 في الطريق","reference":"order-1042","price_halalas":0,"error":null,"bounce":null,"occurred_at":"2026-10-23T09:00:03.512Z","created_at":"2026-10-23T09:00:01.087Z","suppressed":{"reason":"bounce","by":"tawked"}},"type":"email.suppressed","timestamp":"2026-10-09T09:00:03.512Z","sent_at":"1791536403601"},"examples":{"Example":{"title":"Example","value":{"event":"email.suppressed","data":{"id":"0199f1c2-7a41-7c3e-9d2b-5e8f1a2b3c4d","status":"failed","application_id":"c2a10f3e-8b7a-4d2e-9c1a-1a2b3c4d5e6f","from":{"name":"متجر أكمي","address":"orders@acme.sa"},"to":"sara@example.com","recipient":{"id":"0199f1c2-7a42-7b10-8c3d-2a3b4c5d6e7f","address":"sara@example.com","type":"to","status":"suppressed"},"tags":[{"name":"category","value":"order"}],"mode":"live","template":{"id":"0199f1f0-2d3e-7f4a-8b5c-6d7e8f9a0b12","alias":"order-shipped","version":3},"subject":"طلبك 1042 في الطريق","reference":"order-1042","price_halalas":0,"error":null,"bounce":null,"occurred_at":"2026-10-23T09:00:03.512Z","created_at":"2026-10-23T09:00:01.087Z","suppressed":{"reason":"bounce","by":"tawked"}},"type":"email.suppressed","timestamp":"2026-10-09T09:00:03.512Z","sent_at":"1791536403601"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"aa94f1ce-6ede-403a-bd82-1e821763adef":{"description":"Any 2xx answer within 5 seconds acknowledges the delivery. Anything else, a redirect or no answer in time is retried: 5 attempts in all, the first at once and the next after 1 min, 5 min, 30 min, 2 h.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"f1a99a99-6a6a-42b3-93ac-e626d326e9e6":{"bearerKey":{"type":"http","scheme":"bearer","description":"Authorization: Bearer \u003capi key>. An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.","scopes":[],"schemeName":"bearerKey"}},"fe7bec02-0049-4146-a16f-86fd192472c9":{"headerKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"The same API key, with the same access, as a header, for clients that cannot set Authorization.","scopes":[],"schemeName":"headerKey"}}},"servers":{"098b5cff-a5a4-40d5-a09c-d4f2de097e74":{"url":"https://tawked.com","description":"Production (the sandbox is a tk_test_ key on the same host)"},"8e6ac1df-d7eb-4814-92be-cac11ef83826":{"url":"https://tawked.com/api","description":"The same API under /api/v1/..., kept for older integrations"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authorization: Bearer \u003capi key>. An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.","scopes":[],"schemeName":"bearerKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authorization: Bearer \u003capi key>. An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerKey","name":"Authorization"}],"title":"bearerKey"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"The same API key, with the same access, as a header, for clients that cannot set Authorization.","scopes":[],"schemeName":"headerKey"},"schema":{"title":"x-api-key","type":"string","description":"The same API key, with the same access, as a header, for clients that cannot set Authorization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"headerKey","name":"x-api-key"}],"title":"headerKey"}]},"originalFileLocation":"https://tawked.com/openapi.json"},"subdomain":"tawked","siteName":"Tawked","title":"Email suppressed - Tawked","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/webhooks/email-suppressed.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=\"email.suppressed. A recipient was refused by the suppression list, at accept or at send; data.suppressed says why. It is sent beside email.failed with recipient_suppressed: handle one of them. Sent to the application\u0026#x27;s webhook. A message of several recipients sends one per recipient, its data adding recipient and tags after to. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks\u0026#x27; webhook-signature with its whsec_ secret (recommended there); otherwise tawked-signature with the webhook secret, and make handling idempotent on tawked-webhook-id: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tawked\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Email suppressed - Tawked\">\u003cmeta data-mint-head property=\"og:description\" content=\"email.suppressed. A recipient was refused by the suppression list, at accept or at send; data.suppressed says why. It is sent beside email.failed with recipient_suppressed: handle one of them. Sent to the application\u0026#x27;s webhook. A message of several recipients sends one per recipient, its data adding recipient and tags after to. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks\u0026#x27; webhook-signature with its whsec_ secret (recommended there); otherwise tawked-signature with the webhook secret, and make handling idempotent on tawked-webhook-id: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tawked developer docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tawked.com/api-reference/webhooks/email-suppressed\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tawked.com/og/developer-docs-en.png?v=27df06570d\">\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=\"Email suppressed - Tawked\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"email.suppressed. A recipient was refused by the suppression list, at accept or at send; data.suppressed says why. It is sent beside email.failed with recipient_suppressed: handle one of them. Sent to the application\u0026#x27;s webhook. A message of several recipients sends one per recipient, its data adding recipient and tags after to. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks\u0026#x27; webhook-signature with its whsec_ secret (recommended there); otherwise tawked-signature with the webhook secret, and make handling idempotent on tawked-webhook-id: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tawked.com/og/developer-docs-en.png?v=27df06570d\">\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/tawked/1Q4IItpqEOP1_JUm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tawked\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003cmeta data-mint-head name=\"og:image:type\" content=\"image/png\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Tawked developer docs. Verify, WhatsApp, Chat, Email and the Account API\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tawked.com/api-reference/webhooks/email-suppressed\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/email-suppressed.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tawked.com/#organization\",\"name\":\"Tawked\",\"url\":\"https://docs.tawked.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/logo/light.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=353a0cedb91848c1296f205d3552fcca\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tawked.com#website\",\"name\":\"Tawked\",\"url\":\"https://docs.tawked.com\",\"publisher\":{\"@id\":\"https://docs.tawked.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed#webpage\",\"url\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed\",\"name\":\"Email suppressed\",\"description\":\"email.suppressed. A recipient was refused by the suppression list, at accept or at send; data.suppressed says why. It is sent beside email.failed with recipient_suppressed: handle one of them. Sent to the application's webhook. A message of several recipients sends one per recipient, its data adding recipient and tags after to. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks' webhook-signature with its whsec_ secret (recommended there); otherwise tawked-signature with the webhook secret, and make handling idempotent on tawked-webhook-id: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.\",\"isPartOf\":{\"@id\":\"https://docs.tawked.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.tawked.com/api-reference/webhooks/list-webhook-endpoints\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Email suppressed\",\"item\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed#apireference\",\"headline\":\"Email suppressed\",\"name\":\"Email suppressed\",\"description\":\"email.suppressed. A recipient was refused by the suppression list, at accept or at send; data.suppressed says why. It is sent beside email.failed with recipient_suppressed: handle one of them. Sent to the application's webhook. A message of several recipients sends one per recipient, its data adding recipient and tags after to. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks' webhook-signature with its whsec_ secret (recommended there); otherwise tawked-signature with the webhook secret, and make handling idempotent on tawked-webhook-id: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.\",\"url\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tawked.com/api-reference/webhooks/email-suppressed#webpage\"},\"image\":\"https://tawked.com/og/developer-docs-en.png?v=27df06570d\",\"publisher\":{\"@id\":\"https://docs.tawked.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tawked.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tawked\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tawked","nav":{"global":{"anchors":[{"anchor":"Status","icon":"signal","href":"https://tawked.com/en/status"}]},"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Verify","pages":[{"title":"Start a verification","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/start","href":"/api-reference/verify/start-a-verification"},{"title":"Check a code","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/check","href":"/api-reference/verify/check-a-code"},{"title":"Get a verification","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/verify/{id}","href":"/api-reference/verify/get-a-verification"},{"title":"Resend a code","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/{id}/resend","href":"/api-reference/verify/resend-a-code"},{"title":"Cancel a verification","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/{id}/cancel","href":"/api-reference/verify/cancel-a-verification"}]},{"group":"Notifications","pages":[{"title":"Send a template message","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/whatsapp/messages","href":"/api-reference/whatsapp/send-a-template-message"},{"title":"Get a message","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/whatsapp/messages/{id}","href":"/api-reference/whatsapp/get-a-message"},{"title":"List templates","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/whatsapp/templates","href":"/api-reference/whatsapp/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/whatsapp/templates","href":"/api-reference/whatsapp/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/whatsapp/templates/{template_id}","href":"/api-reference/whatsapp/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/whatsapp/templates/{template_id}","href":"/api-reference/whatsapp/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/whatsapp/templates/{template_id}","href":"/api-reference/whatsapp/update-a-template"}]},{"group":"Email","pages":[{"title":"List emails","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/messages","href":"/api-reference/email/list-emails"},{"title":"Send an email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/messages","href":"/api-reference/email/send-an-email"},{"title":"Send a batch of emails","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/messages/batch","href":"/api-reference/email/send-a-batch-of-emails"},{"title":"Get an email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/messages/{id}","href":"/api-reference/email/get-an-email"},{"title":"Reschedule an email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/email/messages/{id}","href":"/api-reference/email/reschedule-an-email"},{"title":"Cancel a scheduled email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/messages/{id}/cancel","href":"/api-reference/email/cancel-a-scheduled-email"},{"title":"Check an email key","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/key","href":"/api-reference/email/check-an-email-key"},{"title":"Get an email's content","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/messages/{id}/content","href":"/api-reference/email/get-an-emails-content"},{"title":"List domains","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/domains","href":"/api-reference/email/list-domains"},{"title":"Add a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/domains","href":"/api-reference/email/add-a-domain"},{"title":"Get a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/domains/{id}","href":"/api-reference/email/get-a-domain"},{"title":"Remove a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/domains/{id}","href":"/api-reference/email/remove-a-domain"},{"title":"Update a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/email/domains/{id}","href":"/api-reference/email/update-a-domain"},{"title":"Check a domain now","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/domains/{id}/verify","href":"/api-reference/email/check-a-domain-now"},{"title":"List suppressed addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/suppressions","href":"/api-reference/email/list-suppressed-addresses"},{"title":"Suppress addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/suppressions","href":"/api-reference/email/suppress-addresses"},{"title":"Look up an address","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/suppressions/{address}","href":"/api-reference/email/look-up-an-address"},{"title":"Lift an address","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/suppressions/{address}","href":"/api-reference/email/lift-an-address"},{"title":"Import suppressed addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/suppressions/imports","href":"/api-reference/email/import-suppressed-addresses"},{"title":"Get an import","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/suppressions/imports/{id}","href":"/api-reference/email/get-an-import"},{"title":"Get email metrics","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/metrics","href":"/api-reference/email/get-email-metrics"},{"title":"List templates","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates","href":"/api-reference/email/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/templates","href":"/api-reference/email/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates/{id}","href":"/api-reference/email/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/templates/{id}","href":"/api-reference/email/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/email/templates/{id}","href":"/api-reference/email/update-a-template"},{"title":"Publish a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/templates/{id}/publish","href":"/api-reference/email/publish-a-template"},{"title":"List a template's versions","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates/{id}/versions","href":"/api-reference/email/list-a-templates-versions"},{"title":"Get a template version","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates/{id}/versions/{number}","href":"/api-reference/email/get-a-template-version"},{"title":"Restore a template version","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/templates/{id}/versions/{number}/restore","href":"/api-reference/email/restore-a-template-version"},{"title":"List received emails","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received","href":"/api-reference/email/list-received-emails"},{"title":"Get a received email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received/{id}","href":"/api-reference/email/get-a-received-email"},{"title":"Delete a received email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/received/{id}","href":"/api-reference/email/delete-a-received-email"},{"title":"Download a received email's raw message","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received/{id}/raw","href":"/api-reference/email/download-a-received-emails-raw-message"},{"title":"Download a received attachment","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received/{id}/attachments/{attachment}","href":"/api-reference/email/download-a-received-attachment"},{"title":"Forward a received email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/received/{id}/forward","href":"/api-reference/email/forward-a-received-email"},{"title":"List receiving addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/inbound-addresses","href":"/api-reference/email/list-receiving-addresses"},{"title":"Simulate a received email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/received/test","href":"/api-reference/email/simulate-a-received-email"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Rotate a webhook secret","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-a-webhook-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-deliveries"},{"title":"Get a delivery","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}/deliveries/{delivery}","href":"/api-reference/webhooks/get-a-delivery"},{"title":"Send a delivery again","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/deliveries/{delivery}/replay","href":"/api-reference/webhooks/send-a-delivery-again"},{"title":"Replay deliveries","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/replay","href":"/api-reference/webhooks/replay-deliveries"},{"title":"Get a replay","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}/replays/{replay}","href":"/api-reference/webhooks/get-a-replay"},{"title":"Verification verified","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook verification.verified","href":"/api-reference/webhooks/verification-verified"},{"title":"Verification failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook verification.failed","href":"/api-reference/webhooks/verification-failed"},{"title":"Verification expired","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook verification.expired","href":"/api-reference/webhooks/verification-expired"},{"title":"Message sent","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.sent","href":"/api-reference/webhooks/message-sent"},{"title":"Message delivered","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.delivered","href":"/api-reference/webhooks/message-delivered"},{"title":"Message read","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.read","href":"/api-reference/webhooks/message-read"},{"title":"Message failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.failed","href":"/api-reference/webhooks/message-failed"},{"title":"Email delivered","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.delivered","href":"/api-reference/webhooks/email-delivered"},{"title":"Email bounced","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.bounced","href":"/api-reference/webhooks/email-bounced"},{"title":"Email complained","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.complained","href":"/api-reference/webhooks/email-complained"},{"title":"Email failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.failed","href":"/api-reference/webhooks/email-failed"},{"title":"Email sent","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.sent","href":"/api-reference/webhooks/email-sent"},{"title":"Email delivery delayed","description":"`email.delivery_delayed`. The receiving server delayed the message for the first time; `data.delay` carries the type and when the attempts stop. Sent to the application's webhook. A message of several recipients sends one per recipient, its `data` adding `recipient` and `tags` after `to`. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks' `webhook-signature` with its `whsec_` secret (recommended there); otherwise `tawked-signature` with the webhook secret, and make handling idempotent on `tawked-webhook-id`: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.delivery_delayed","href":"/api-reference/webhooks/email-delivery-delayed"},{"title":"Email suppressed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.suppressed","href":"/api-reference/webhooks/email-suppressed"},{"title":"Email scheduled","description":"`email.scheduled`. A scheduled message was accepted or rescheduled; `data.scheduled_at` is its time. Sent to the application's webhook. A message of several recipients sends one per recipient, its `data` adding `recipient` and `tags` after `to`. Verify one scheme against the raw body before trusting it: on an endpoint with Standard signing on, Standard Webhooks' `webhook-signature` with its `whsec_` secret (recommended there); otherwise `tawked-signature` with the webhook secret, and make handling idempotent on `tawked-webhook-id`: a delivery can arrive more than once, and deliveries are not guaranteed to arrive in order.","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.scheduled","href":"/api-reference/webhooks/email-scheduled"},{"title":"Email canceled","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.canceled","href":"/api-reference/webhooks/email-canceled"},{"title":"Email opened","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.opened","href":"/api-reference/webhooks/email-opened"},{"title":"Email clicked","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.clicked","href":"/api-reference/webhooks/email-clicked"},{"title":"Domain created","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.created","href":"/api-reference/webhooks/domain-created"},{"title":"Domain verified","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.verified","href":"/api-reference/webhooks/domain-verified"},{"title":"Domain failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.failed","href":"/api-reference/webhooks/domain-failed"},{"title":"Domain removed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.removed","href":"/api-reference/webhooks/domain-removed"},{"title":"Suppression added","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook suppression.added","href":"/api-reference/webhooks/suppression-added"},{"title":"Suppression removed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook suppression.removed","href":"/api-reference/webhooks/suppression-removed"},{"title":"Email received","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.received","href":"/api-reference/webhooks/email-received"},{"title":"Service approved","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.approved","href":"/api-reference/webhooks/service-approved"},{"title":"Service rejected","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.rejected","href":"/api-reference/webhooks/service-rejected"},{"title":"Service suspended","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.suspended","href":"/api-reference/webhooks/service-suspended"},{"title":"Service resumed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.resumed","href":"/api-reference/webhooks/service-resumed"},{"title":"Service paused","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.paused","href":"/api-reference/webhooks/service-paused"},{"title":"Service unpaused","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.unpaused","href":"/api-reference/webhooks/service-unpaused"},{"title":"Service review requested","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.review_requested","href":"/api-reference/webhooks/service-review-requested"},{"title":"Service archived","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.archived","href":"/api-reference/webhooks/service-archived"},{"title":"Service restored","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.restored","href":"/api-reference/webhooks/service-restored"},{"title":"Balance low","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook balance.low","href":"/api-reference/webhooks/balance-low"},{"title":"Verification verified partner","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook partner.verification.verified","href":"/api-reference/webhooks/verification-verified-partner"},{"title":"Verification failed partner","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook partner.verification.failed","href":"/api-reference/webhooks/verification-failed-partner"},{"title":"Verification expired partner","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook partner.verification.expired","href":"/api-reference/webhooks/verification-expired-partner"}]},{"group":"Chat","pages":[{"title":"List menus","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/chat/menus","href":"/api-reference/chat/list-menus"},{"title":"Add a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/chat/menus","href":"/api-reference/chat/add-a-menu"},{"title":"Get a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/chat/menus/{id}","href":"/api-reference/chat/get-a-menu"},{"title":"Delete a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/chat/menus/{id}","href":"/api-reference/chat/delete-a-menu"},{"title":"Update a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/chat/menus/{id}","href":"/api-reference/chat/update-a-menu"},{"title":"Get the auto-attendant","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/chat/attendant","href":"/api-reference/chat/get-the-auto-attendant"},{"title":"Save the auto-attendant draft","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json put /v1/chat/attendant/draft","href":"/api-reference/chat/save-the-auto-attendant-draft"},{"title":"Publish the auto-attendant","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/chat/attendant/publish","href":"/api-reference/chat/publish-the-auto-attendant"},{"title":"Switch the auto-attendant on or off","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json put /v1/chat/attendant/state","href":"/api-reference/chat/switch-the-auto-attendant-on-or-off"},{"title":"Update the auto-attendant settings","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/chat/attendant/settings","href":"/api-reference/chat/update-the-auto-attendant-settings"}]},{"group":"Partner API","pages":[{"title":"Get the profile","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/profile","href":"/api-reference/partner/get-the-profile"},{"title":"Preview the screening","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/screening","href":"/api-reference/partner/preview-the-screening"},{"title":"List applications","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/applications","href":"/api-reference/partner/list-applications"},{"title":"Provision an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications","href":"/api-reference/partner/provision-an-application"},{"title":"Provision in bulk","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/batch","href":"/api-reference/partner/provision-in-bulk"},{"title":"Get an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/applications/{external_id}","href":"/api-reference/partner/get-an-application"},{"title":"Update the brand","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/partner/applications/{external_id}","href":"/api-reference/partner/update-the-brand"},{"title":"Get the history","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/applications/{external_id}/history","href":"/api-reference/partner/get-the-history"},{"title":"Upload the logo","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/logo","href":"/api-reference/partner/upload-the-logo"},{"title":"Remove the logo","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/partner/applications/{external_id}/logo","href":"/api-reference/partner/remove-the-logo"},{"title":"Update the verify settings","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/partner/applications/{external_id}/verify-settings","href":"/api-reference/partner/update-the-verify-settings"},{"title":"Suspend an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/suspend","href":"/api-reference/partner/suspend-an-application"},{"title":"Resume an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/resume","href":"/api-reference/partner/resume-an-application"},{"title":"Unpause an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/unpause","href":"/api-reference/partner/unpause-an-application"},{"title":"Archive an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/archive","href":"/api-reference/partner/archive-an-application"},{"title":"Restore an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/restore","href":"/api-reference/partner/restore-an-application"},{"title":"Get usage","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/usage","href":"/api-reference/partner/get-usage"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/verifications","href":"/api-reference/partner/list-verifications"},{"title":"Get the event feed","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/events","href":"/api-reference/partner/get-the-event-feed"},{"title":"Get the webhook","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/webhook","href":"/api-reference/partner/get-the-webhook"},{"title":"Update the webhook","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json put /v1/partner/webhook","href":"/api-reference/partner/update-the-webhook"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/webhook/deliveries","href":"/api-reference/partner/list-deliveries"},{"title":"Retry a delivery","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/webhook/deliveries/{id}/retry","href":"/api-reference/partner/retry-a-delivery"}]}]},{"tab":"Account API","icon":"user-gear","pages":[{"title":"Account API","href":"/account-api/overview"}]},{"tab":"Changelog","icon":"list","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Email suppressed - Tawked","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}