{
"status": 401,
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Unauthorized",
"detail": "Missing at least one of the required scopes"
}
{
"status": 401,
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Too Many Requests",
"detail": "Rate limit exceeded for Client Id"
}
Customers
Lapse customers
A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced.
Lapsing is a permanent action. It can be reversed by recording a new transaction for the customer.
Lapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the GET /v2/customers endpoint to determine if the customer is active or not. Approximate time to lapse is
normally under < 5 minutes, but can be several hours in some cases.
Customers who we were able to queue will be returned in the accepted array. Customers who we do not hold a record of or cannot find will be returned in the errors array.
Scopes:customers:write
Rate limits: 300 requests per 5 minutes. Shared across all ‘customers’ endpoints.
{
"status": 401,
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
"title": "Unauthorized",
"detail": "Missing at least one of the required scopes"
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Mention Me Docs","colors":{"primary":"#4C57E6","light":"#FF3EB5","dark":"#21174B"},"logo":{"light":"https://mintcdn.com/mentionme/V2LNKGCh7ROBia07/logo/light.svg?fit=max\u0026auto=format\u0026n=V2LNKGCh7ROBia07\u0026q=85\u0026s=747c8cd37a71a653a020675616c849f3","dark":"https://mintcdn.com/mentionme/V2LNKGCh7ROBia07/logo/dark.svg?fit=max\u0026auto=format\u0026n=V2LNKGCh7ROBia07\u0026q=85\u0026s=100c40618765923e52d9db84344692e6"},"favicon":"https://mintcdn.com/mentionme/Dcv4Ct-ZIyuK4Pcd/favicon.ico?fit=max\u0026auto=format\u0026n=Dcv4Ct-ZIyuK4Pcd\u0026q=85\u0026s=cc9c8c8b015455ba82e2820c8306a4ab","background":{"color":{"light":"#FFFFFF","dark":"#22272E"}},"navbar":{"primary":{"type":"button","label":"Contact support","href":"https://help.mention-me.com/hc/en-gb/requests/new"}},"footer":{"socials":{"x":"https://x.com/mentionme","linkedin":"https://linkedin.com/company/mention-me"},"links":[{"header":"Company","items":[{"label":"Website","href":"https://www.mention-me.com"},{"label":"Platform","href":"https://app.mention-me.com"},{"label":"Support","href":"https://help.mention-me.com/hc/en-gb/requests/new"},{"label":"Status","href":"https://status.mention-me.com"}]}]},"seo":{"metatags":{"og:site_name":"Mention Me Docs"}},"errors":{"404":{"redirect":true,"title":"Page not found","description":"The page you're looking for may have moved. Try searching or head back to the [home page](/knowledge/getting-started/overview)."}},"contextual":{"options":["assistant","copy","claude","chatgpt","cursor","mcp","add-mcp"],"display":"toc"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Submit a Request","icon":"headset","href":"https://help.mention-me.com/hc/en-gb/requests/new"},{"anchor":"Platform","icon":"gauge","href":"https://app.mention-me.com"},{"anchor":"Status","icon":"signal","href":"https://status.mention-me.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mentionme","hasAudioNarration":false,"actualSubdomain":"mentionme","customDomains":["docs.mention-me.com"],"gitSource":{"type":"github","owner":"mention-me","repo":"mention-me-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af2019b0da5396f96340ce0","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Guides","count":365},{"language":"default","tag":"Integrations","count":73},{"language":"default","tag":"Referral","count":57},{"language":"default","tag":"Documentation","count":50},{"language":"default","tag":"API \u0026 Webhooks","count":45},{"language":"default","tag":"Customers","count":44},{"language":"default","tag":"Reporting","count":43},{"language":"default","tag":"Campaigns","count":42},{"language":"default","tag":"ESP \u0026 CRM Integrations","count":38},{"language":"default","tag":"Getting Started","count":32}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".mm-partner-badge{padding:0 16px 8px;margin-bottom:10px}.mm-partner-badge-inner{display:flex;flex-wrap:wrap;gap:6px;align-items:center;padding:6px 10px;font-size:12px;line-height:1.3;color:#9ca3af;border:1px solid rgba(0, 0, 0, 0.07);border-radius:6px}.dark .mm-partner-badge-inner{border-color:rgba(255, 255, 255, 0.08)}.mm-partner-badge-content{min-width:0}.mm-partner-badge-context{color:#9ca3af}.dark .mm-partner-badge-context{color:#6b7280}.mm-partner-badge-name{font-weight:500;color:#6b7280}.dark .mm-partner-badge-name{color:#9ca3af}.mm-partner-badge-code{font-family:ui-monospace, SFMono-Regular, Menlo, monospace;color:#9ca3af}.dark .mm-partner-badge-code{color:#6b7280}.mm-partner-badge-reset{all:unset;flex-shrink:0;font-size:13px;line-height:1;color:inherit;cursor:pointer;opacity:0.3}.mm-partner-badge-reset:hover{opacity:0.7}.mm-partner-badge-switch{all:unset;flex-shrink:0;font-size:11px;line-height:1;color:#6b7280;text-decoration:underline;text-underline-offset:2px;cursor:pointer;opacity:0.8}.mm-partner-badge-switch:hover{opacity:1}.dark .mm-partner-badge-switch{color:#9ca3af}.mm-partner-badge-reenable{all:unset;color:#6b7280;text-decoration:underline;text-underline-offset:2px;cursor:pointer}.mm-partner-badge-reenable:hover{color:#4b5563}.dark .mm-partner-badge-reenable{color:#9ca3af}.dark .mm-partner-badge-reenable:hover{color:#d1d5db}pre code{width:auto!important;min-width:0!important;max-width:100%!important;padding:0!important;word-break:break-all!important;overflow-wrap:break-word!important;white-space:pre-wrap!important}body:has(.docs-home) #header,body:has(.docs-home) #page-title{display:none}body:has(.docs-home) #content-container,body:has(.docs-home) article,body:has(.docs-home) .prose{max-width:none}html:has(.docs-home){background-color:#ffffff}body:has(.docs-home){background:transparent}body:has(.docs-home) #background-color{background-color:#ffffff;background-image:radial-gradient(ellipse 120% 80% at 50% -10%, #c9cef8 0%, transparent 58%),\n radial-gradient(ellipse 70% 55% at 0% 30%, #f7cce8 0%, transparent 55%),\n radial-gradient(ellipse 60% 50% at 100% 15%, #d4d8f8 0%, transparent 50%);background-repeat:no-repeat}html.dark:has(.docs-home){background-color:#22272e}html.dark body:has(.docs-home){background:transparent}html.dark body:has(.docs-home) #background-color{background-color:#22272e;background-image:radial-gradient(ellipse 120% 80% at 50% -10%, #3d4280 0%, transparent 58%),\n radial-gradient(ellipse 70% 55% at 0% 30%, #5a3350 0%, transparent 55%),\n radial-gradient(ellipse 60% 50% at 100% 15%, #3a3f73 0%, transparent 50%);background-repeat:no-repeat}body:has(.docs-home) main,body:has(.docs-home) #content-container{min-height:100vh;background:transparent}.docs-home{width:100%;padding:0 1.25rem 5rem}.docs-home-inner{max-width:72rem;margin:0 auto}.docs-home-hero{max-width:1000px;padding:5.5rem 0 2.75rem;margin:0 auto;text-align:center}.docs-home-title{max-width:1000px;margin:0 auto 2.5rem;font-size:4rem;font-weight:600;line-height:4.5rem;color:#21174b;letter-spacing:-1px}.dark .docs-home-title{color:#f4f2fb}.docs-home-lede{margin:0;font-size:1rem;line-height:1.45;color:#5c5674}.docs-home-why{margin:1.15rem 0 0}.docs-home-why a{display:inline-flex;gap:0.45rem;align-items:center;padding:0.5rem 0.95rem 0.5rem 0.75rem;font-size:0.9rem;font-weight:500;line-height:1.2;color:#21174b;text-decoration:none;background:rgba(255, 255, 255, 0.72);border:1px solid rgba(33, 23, 75, 0.2);border-radius:999px}.docs-home-why a:hover{color:#4c57e6;border-color:#4c57e6}.docs-home-why a svg{width:1rem;height:1rem}.dark .docs-home-why a{color:#f4f2fb;background:rgba(34, 39, 46, 0.55);border-color:rgba(255, 255, 255, 0.2)}.dark .docs-home-why a:hover{color:#c5c9f8;border-color:#c5c9f8}.docs-home-platforms{max-width:650px;margin:0 auto}.docs-home-section-title{margin:3.5rem 0 1.75rem;font-size:1.75rem;font-weight:600;line-height:2.25rem;color:#21174b;text-align:center;letter-spacing:-0.5px}.dark .docs-home-section-title{color:#f4f2fb}.docs-home-topics{margin-top:0}.dark .docs-home-lede{color:#b4afc6}@media (max-width: 640px){.docs-home-title{font-size:2.5rem;line-height:2.85rem}}.cl-meta{display:flex;flex-wrap:wrap;gap:0.4rem 0.55rem;align-items:center;margin:0 0 1.25rem;font-size:0.8rem;font-weight:500;line-height:1.2;color:#5c5674}.cl-meta-date{font-variant-numeric:tabular-nums}.dark .cl-meta{color:#b4afc6}.cl-pill{display:inline-flex;align-items:center;padding:0.18rem 0.5rem;font-size:0.7rem;font-weight:600;line-height:1.2;letter-spacing:0.01em;border-radius:999px}.cl-pill-new{color:#4c57e6;background:rgba(76, 87, 230, 0.1)}.cl-pill-improved{color:#5c5674;background:rgba(33, 23, 75, 0.06)}.cl-pill-fixed{color:#8a2e6a;background:rgba(255, 62, 181, 0.1)}.cl-pill-area{color:#5c5674;background:transparent;border:1px solid rgba(33, 23, 75, 0.12)}.dark .cl-pill-new{color:#c5c9f8;background:rgba(76, 87, 230, 0.22)}.dark .cl-pill-improved{color:#d5d1e4;background:rgba(255, 255, 255, 0.06)}.dark .cl-pill-fixed{color:#f5b6dd;background:rgba(255, 62, 181, 0.16)}.dark .cl-pill-area{color:#d5d1e4;border-color:rgba(255, 255, 255, 0.14)}.cl-pill-platform-update{color:#21174b;background:rgba(76, 87, 230, 0.1)}.dark .cl-pill-platform-update{color:#c5c9f8;background:rgba(76, 87, 230, 0.22)}.cl-author{margin:0.85rem 0 0;font-size:0.875rem;font-weight:600;color:#21174b}.dark .cl-author{color:#f4f2fb}"}],"page":{"pagePath":"api-reference/merchant/customers/lapse-customers","slug":"/api-reference/merchant/customers/lapse-customers","pageMetadata":{"title":"Lapse customers","description":"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced.\n\nLapsing is a permanent action. It can be reversed by recording a new transaction for the customer.\n\nLapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the `GET /v2/customers` endpoint to determine if the customer is active or not. Approximate time to lapse is\nnormally under \u003c 5 minutes, but can be several hours in some cases.\n\nCustomers who we were able to queue will be returned in the `accepted` array. Customers who we do not hold a record of or cannot find will be returned in the `errors` array.\n\n**Scopes:** `customers:write`\n\n**Rate limits:** 300 requests per 5 minutes. Shared across all 'customers' endpoints.","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/lapse","href":"/api-reference/merchant/customers/lapse-customers","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Lapsing is a permanent action. It can be reversed by recording a new transaction for the customer.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Lapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the \", _jsx(_components.code, {\n children: \"GET /v2/customers\"\n }), \" endpoint to determine if the customer is active or not. Approximate time to lapse is\\nnormally under \u003c 5 minutes, but can be several hours in some cases.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Customers who we were able to queue will be returned in the \", _jsx(_components.code, {\n children: \"accepted\"\n }), \" array. Customers who we do not hold a record of or cannot find will be returned in the \", _jsx(_components.code, {\n children: \"errors\"\n }), \" array.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scopes:\"\n }), \" \", _jsx(_components.code, {\n children: \"customers:write\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Rate limits:\"\n }), \" 300 requests per 5 minutes. Shared across all ‘customers’ endpoints.\"]\n })]\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":"Lapse customers","description":"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced.\n\nLapsing is a permanent action. It can be reversed by recording a new transaction for the customer.\n\nLapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the `GET /v2/customers` endpoint to determine if the customer is active or not. Approximate time to lapse is\nnormally under \u003c 5 minutes, but can be several hours in some cases.\n\nCustomers who we were able to queue will be returned in the `accepted` array. Customers who we do not hold a record of or cannot find will be returned in the `errors` array.\n\n**Scopes:** `customers:write`\n\n**Rate limits:** 300 requests per 5 minutes. Shared across all 'customers' endpoints.","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/lapse","href":"/api-reference/merchant/customers/lapse-customers","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mentionme/585da3591117c76f/clerk-loader.js","/_mintlify/custom/mentionme/8c2fd5fe6a58ba82/posthog.js","/_mintlify/custom/mentionme/6b3953f5758cd5c3/tests/sftp-tree.js","/_mintlify/custom/mentionme/621493ede3850bd6/version-switch.js"],"openApiReferenceData":{"operation":{"tags":["Customers"],"summary":"Lapse customers","description":"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced.\n\nLapsing is a permanent action. It can be reversed by recording a new transaction for the customer.\n\nLapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the `GET /v2/customers` endpoint to determine if the customer is active or not. Approximate time to lapse is\nnormally under \u003c 5 minutes, but can be several hours in some cases.\n\nCustomers who we were able to queue will be returned in the `accepted` array. Customers who we do not hold a record of or cannot find will be returned in the `errors` array.\n\n**Scopes:** `customers:write`\n\n**Rate limits:** 300 requests per 5 minutes. Shared across all 'customers' endpoints.","operationId":"post_merchant_api_customers_lapse","requestBody":"7bdcf16a-8805-4aea-87ad-1b86756dcfad","responses":{"202":"971f47da-1ae9-4110-af2d-598a40928799","401":"91be8d70-fdf2-4ef0-b00b-ec0f71fad41a","404":"db916049-4bc3-4932-8aaa-8cdc3c77e87d","429":"95bb5b27-3ff4-4531-aeb1-e17511add083"},"method":"post","type":"path","servers":["9cad4bbc-abba-47b4-af3a-4be329962143","73726060-9f20-4a03-aa5c-0fa63ceb245d"],"security":["b97e017c-9cb8-43ec-8bed-dbddd67299dc"],"path":"/api/merchant/v2/customers/lapse","baseUrlOptions":["https://mention-me.com","https://demo.mention-me.com"],"title":"Lapse customers","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"A collection of identifiers for customers in Mention Me.","required":["identifiers"],"properties":{"identifiers":{"description":"Maximum of 100 identifiers.","type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"description":"The type of identifier.","type":"string","enum":["email"],"isRequired":true,"uniqueKey":"identifiers.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","default":"","maxLength":320,"minLength":1,"pattern":".+\\@\\S+\\.\\S+","uniqueKey":"identifiers.items.[INDEX].oneOf.0.value","typeLabel":"string"}},"uniqueKey":"identifiers.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"description":"The type of identifier.","type":"string","enum":["customerId"],"isRequired":true,"uniqueKey":"identifiers.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"identifiers.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"identifiers.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"identifiers.items.[INDEX]","typeLabel":"object"},"maxItems":100,"minItems":1,"isRequired":true,"uniqueKey":"identifiers","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"identifiers":[{"type":"email","value":""}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"971f47da-1ae9-4110-af2d-598a40928799":{"description":"All identifiers that were queued to be marked as lapsed.","content":{"application/json":{"schema":{"description":"A collection of customer identifiers which were accepted, or resulted in an error.","properties":{"accepted":{"description":"All the identifiers that were accepted.","type":"array","items":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"description":"The type of identifier.","type":"string","enum":["email"],"isRequired":true,"uniqueKey":"accepted.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","default":"","maxLength":320,"minLength":1,"pattern":".+\\@\\S+\\.\\S+","uniqueKey":"accepted.items.[INDEX].oneOf.0.value","typeLabel":"string"}},"uniqueKey":"accepted.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"description":"The type of identifier.","type":"string","enum":["customerId"],"isRequired":true,"uniqueKey":"accepted.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"accepted.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"accepted.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"accepted.items.[INDEX]","typeLabel":"object"},"maxItems":100,"minItems":0,"uniqueKey":"accepted","typeLabel":"object[]"},"errors":{"description":"All the identifiers which resulted in errors.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["email","customerId"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","uniqueKey":"errors.items.[INDEX].value","typeLabel":"string"},"reason":{"type":"string","enum":["notFound"],"uniqueKey":"errors.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"maxItems":100,"minItems":0,"uniqueKey":"errors","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"accepted":[{"type":"email","value":""}],"errors":[{"type":"email","value":"\u003cstring>","reason":"notFound"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"91be8d70-fdf2-4ef0-b00b-ec0f71fad41a":{"description":"Required scopes are missing.","content":{"application/problem+json":{"schema":{"properties":{"status":{"type":"integer","maximum":599,"minimum":200,"example":401,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","example":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","example":"Unauthorized","uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","example":"Missing at least one of the required scopes","uniqueKey":"detail","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":401,"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","title":"Unauthorized","detail":"Missing at least one of the required scopes"}}},"exampleType":"generated"}},"exampleType":"generated"},"db916049-4bc3-4932-8aaa-8cdc3c77e87d":{"description":"No customers matched the identifiers.","content":{"application/problem+json":{"schema":{"properties":{"status":{"type":"integer","maximum":599,"minimum":200,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","example":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":399,"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","title":"\u003cstring>","detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"95bb5b27-3ff4-4531-aeb1-e17511add083":{"description":"Rate limit exceeded.","content":{"application/problem+json":{"schema":{"properties":{"status":{"type":"integer","maximum":599,"minimum":200,"example":401,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","example":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","example":"Too Many Requests","uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","example":"Rate limit exceeded for Client Id","uniqueKey":"detail","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":401,"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html","title":"Too Many Requests","detail":"Rate limit exceeded for Client Id"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b97e017c-9cb8-43ec-8bed-dbddd67299dc":{"Bearer":{"type":"http","description":"RFC8725 Compliant JWT","bearerFormat":"JWT","scheme":"bearer","scopes":[]}}},"servers":{"9cad4bbc-abba-47b4-af3a-4be329962143":{"url":"https://mention-me.com","description":"Production"},"73726060-9f20-4a03-aa5c-0fa63ceb245d":{"url":"https://demo.mention-me.com","description":"Demo"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"RFC8725 Compliant JWT","bearerFormat":"JWT","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"RFC8725 Compliant JWT","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi/merchant_api.oas.json"},"subdomain":"mentionme","siteName":"Mention Me Docs","title":"Lapse customers - Mention Me Docs","navMaps":{"firstHrefInVersion":{"Classic docs":{"href":"/api-reference/merchant/customers/lapse-customers","matchLevel":0},"Mention Me docs":{"href":"/api-reference/merchant/customers/lapse-customers","matchLevel":0}},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/merchant/customers/lapse-customers.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=\"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced. Lapsing is a permanent action. It can be reversed by recording a new transaction for the customer. Lapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the GET /v2/customers endpoint to determine if the customer is active or not. Approximate time to lapse is normally under \u0026lt; 5 minutes, but can be several hours in some cases. Customers who we were able to queue will be returned in the accepted array. Customers who we do not hold a record of or cannot find will be returned in the errors array. Scopes: customers:write Rate limits: 300 requests per 5 minutes. Shared across all \u0026#x27;customers\u0026#x27; endpoints.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Mention Me Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_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/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mentionme/C55mfF-eb_dz8RU1/_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/mentionme/C55mfF-eb_dz8RU1/_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/mentionme/C55mfF-eb_dz8RU1/_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/mentionme/C55mfF-eb_dz8RU1/_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/mentionme/C55mfF-eb_dz8RU1/_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/mentionme/C55mfF-eb_dz8RU1/_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/mentionme/C55mfF-eb_dz8RU1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Lapse customers - Mention Me Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced. Lapsing is a permanent action. It can be reversed by recording a new transaction for the customer. Lapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the GET /v2/customers endpoint to determine if the customer is active or not. Approximate time to lapse is normally under \u0026lt; 5 minutes, but can be several hours in some cases. Customers who we were able to queue will be returned in the accepted array. Customers who we do not hold a record of or cannot find will be returned in the errors array. Scopes: customers:write Rate limits: 300 requests per 5 minutes. Shared across all \u0026#x27;customers\u0026#x27; endpoints.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mention Me Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mentionme.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Lapse+customers\u0026amp;description=A+customer+who+is+lapsed+is+one+who+you+no+longer+consider+an+existing+customer.+This+can+be+used+to+allow+the+customer+to+be+referred+again.+A+common+use+case+\u0026amp;theme=52d9a28de14b1f3580df43c7\u0026amp;signature=f88650b56e126b2375334247caf96091fb9e2bae465fae49ae7e6ae1581fefe7\">\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=\"Lapse customers - Mention Me Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced. Lapsing is a permanent action. It can be reversed by recording a new transaction for the customer. Lapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the GET /v2/customers endpoint to determine if the customer is active or not. Approximate time to lapse is normally under \u0026lt; 5 minutes, but can be several hours in some cases. Customers who we were able to queue will be returned in the accepted array. Customers who we do not hold a record of or cannot find will be returned in the errors array. Scopes: customers:write Rate limits: 300 requests per 5 minutes. Shared across all \u0026#x27;customers\u0026#x27; endpoints.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mentionme.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Lapse+customers\u0026amp;description=A+customer+who+is+lapsed+is+one+who+you+no+longer+consider+an+existing+customer.+This+can+be+used+to+allow+the+customer+to+be+referred+again.+A+common+use+case+\u0026amp;theme=52d9a28de14b1f3580df43c7\u0026amp;signature=f88650b56e126b2375334247caf96091fb9e2bae465fae49ae7e6ae1581fefe7\">\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/mentionme/C55mfF-eb_dz8RU1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mention Me Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4C57E6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/merchant/customers/lapse-customers.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.mention-me.com/#organization\",\"name\":\"Mention Me Docs\",\"url\":\"https://docs.mention-me.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mentionme/V2LNKGCh7ROBia07/logo/light.svg?fit=max\u0026auto=format\u0026n=V2LNKGCh7ROBia07\u0026q=85\u0026s=747c8cd37a71a653a020675616c849f3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.mention-me.com#website\",\"name\":\"Mention Me Docs\",\"url\":\"https://docs.mention-me.com\",\"publisher\":{\"@id\":\"https://docs.mention-me.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers#webpage\",\"url\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers\",\"name\":\"Lapse customers\",\"description\":\"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced. Lapsing is a permanent action. It can be reversed by recording a new transaction for the customer. Lapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the GET /v2/customers endpoint to determine if the customer is active or not. Approximate time to lapse is normally under \\u003c 5 minutes, but can be several hours in some cases. Customers who we were able to queue will be returned in the accepted array. Customers who we do not hold a record of or cannot find will be returned in the errors array. Scopes: customers:write Rate limits: 300 requests per 5 minutes. Shared across all 'customers' endpoints.\",\"isPartOf\":{\"@id\":\"https://docs.mention-me.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Merchant API\",\"item\":\"https://docs.mention-me.com/api-reference/merchant-api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://docs.mention-me.com/api-reference/merchant/customers/get-customers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Lapse customers\",\"item\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers#apireference\",\"headline\":\"Lapse customers\",\"name\":\"Lapse customers\",\"description\":\"A customer who is lapsed is one who you no longer consider an existing customer. This can be used to allow the customer to be referred again. A common use case for this is in subscription businesses where a customer has cancelled their subscription and is no longer a customer - you can mark them as lapsed to enable them to be re-introduced. Lapsing is a permanent action. It can be reversed by recording a new transaction for the customer. Lapsing is done on a queue. It may take some time for the customers to be recorded as lapsed. We recommend using the GET /v2/customers endpoint to determine if the customer is active or not. Approximate time to lapse is normally under \\u003c 5 minutes, but can be several hours in some cases. Customers who we were able to queue will be returned in the accepted array. Customers who we do not hold a record of or cannot find will be returned in the errors array. Scopes: customers:write Rate limits: 300 requests per 5 minutes. Shared across all 'customers' endpoints.\",\"url\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers\",\"mainEntityOfPage\":{\"@id\":\"https://docs.mention-me.com/api-reference/merchant/customers/lapse-customers#webpage\"},\"publisher\":{\"@id\":\"https://docs.mention-me.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.mention-me.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mention Me Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Mention Me Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/merchant/customers/lapse-customers.md","siteName":"Mention Me Docs","nav":{"global":{"anchors":[{"anchor":"Submit a Request","icon":"headset","href":"https://help.mention-me.com/hc/en-gb/requests/new"},{"anchor":"Platform","icon":"gauge","href":"https://app.mention-me.com"},{"anchor":"Status","icon":"signal","href":"https://status.mention-me.com"}]},"versions":[{"version":"Classic docs","default":true,"tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/knowledge/getting-started/overview"}]},{"tab":"Documentation","icon":"code","pages":[{"title":"Documentation","href":"/developer-docs/integration/overview"}]},{"tab":"API \u0026 Webhooks","icon":"square-terminal","groups":[{"group":"Getting Started","pages":[{"title":"API Reference","sidebarTitle":"Overview","href":"/api-reference/introduction"},{"title":"Environments","href":"/api-reference/getting-started/environments"},{"title":"Errors","href":"/api-reference/getting-started/errors"},{"title":"Rate Limits","href":"/api-reference/getting-started/rate-limits"}]},{"group":"Auth API","pages":[{"title":"Authentication","href":"/api-reference/authentication/overview"},{"title":"Create an API Key","href":"/api-reference/authentication/create-api-key"},{"title":"Getting an Access Token","href":"/api-reference/authentication/access-token"},{"title":"Scopes","href":"/api-reference/authentication/scopes"},{"group":"Auth","pages":[{"title":"Get access token","deprecated":null,"version":null,"openapi":"/openapi/auth_api.oas.json post /api/oauth/token","href":"/api-reference/auth/auth/get-access-token"}]}]},{"group":"Merchant API","pages":[{"title":"Overview","href":"/api-reference/merchant-api/overview"},{"title":"Your First Merchant API Request","href":"/api-reference/merchant-api/first-request"},{"group":"Coupons","pages":[{"title":"Validate coupon code","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json get /api/merchant/v2/coupons/validate/{coupon_code}","href":"/api-reference/merchant/coupons/validate-coupon-code"}]},{"group":"Customers","pages":[{"title":"Get customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers","href":"/api-reference/merchant/customers/get-customers"},{"title":"Purge customers","description":"Purge all customers matching the given identifiers.\n\nPurging is a permanent action. Once a customer is purged, they cannot be recovered.\n\nPurging is done on a queue. It may take some time for the customers to be purged. We recommend using the `GET /v2/customers` endpoint to determine if the customers have been purged. Approximate time to purge is\nnormally under \u003c 5 minutes, but can be several hours in some cases.\n\nCustomers who we were able to queue will be returned in the `accepted` array. Customers who we do not hold a record of or cannot find will be returned in the `errors` array.\n\n**Scopes:** `customers:delete`\n\n**Rate limits:** 300 requests per 5 minutes. Shared across all 'customers_purge' endpoints.","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json delete /api/merchant/v2/customers","href":"/api-reference/merchant/customers/purge-customers"},{"title":"Lapse customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/lapse","href":"/api-reference/merchant/customers/lapse-customers"},{"title":"Get customer rewards","description":"Returns all rewards a customer has been given.\n\nRewards that are fulfilled outside of Mention Me will not be returned.\n\n**Scopes:** `customers:read`, `rewards:read`\n\n**Rate limits:** 300 requests per 5 minutes. Shared across all 'rewards' endpoints.","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/rewards","href":"/api-reference/merchant/customers/get-customer-rewards"}]},{"group":"Referee","pages":[{"title":"Referee cancellations","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/cancellation","href":"/api-reference/merchant/referee/referee-cancellations"},{"title":"Referee eligibility","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/eligibility","href":"/api-reference/merchant/referee/referee-eligibility"}]}]},{"group":"Entrypoint API","pages":[{"title":"Overview","href":"/api-reference/entry-point-api/overview"},{"group":"Referrer promotion","pages":[{"title":"Referrer Promotion","href":"/api-reference/entry-point-api/referrer-promotion"},{"title":"Enrol a customer in an offer","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/offer","href":"/api-reference/referrer/enrol-a-customer-in-an-offer"}]},{"group":"Referee integration","pages":[{"title":"Referee Integration","href":"/api-reference/entry-point-api/referee-integration"},{"title":"Find a friend by name","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/referee","href":"/api-reference/referee/find-a-friend-by-name"}]},{"group":"Referrer dashboard","pages":[{"title":"Referrer Dashboard","href":"/api-reference/entry-point-api/referrer-dashboard"},{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/dashboard","href":"/api-reference/dashboard/get-dashboard"}]},{"title":"Authentication Token","href":"/api-reference/entry-point-api/authentication-token"},{"title":"PostMessage Iframe Events","sidebarTitle":"PostMessage Iframe","href":"/api-reference/entry-point-api/postmessage"}]},{"group":"Consumer API","pages":[{"title":"Overview","href":"/api-reference/consumer-api/overview"},{"group":"Order tracking","pages":[{"title":"Order Tracking","href":"/api-reference/consumer-api/order-tracking"},{"title":"Record order","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/order","href":"/api-reference/record-order/record-order"},{"title":"Record order with a coupon","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/coupon_redemption","href":"/api-reference/record-order/record-order-with-a-coupon"}]},{"group":"Enrol referrer","pages":[{"title":"Enrol referrer","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referrer/enrol","href":"/api-reference/enrol-referrer/enrol-referrer"}]},{"group":"Referrer dashboard","pages":[{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/dashboard","href":"/api-reference/get-referrer-dashboard/get-dashboard"}]},{"group":"Find a friend","pages":[{"title":"Find a friend","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search","href":"/api-reference/find-referrer-by-name/find-a-friend"},{"title":"Find a friend content","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search/content","href":"/api-reference/find-referrer-by-name/find-a-friend-content"}]},{"group":"Register referee","pages":[{"title":"Register referee","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referee/register","href":"/api-reference/link-new-customer-to-referrer/register-referee"}]},{"group":"Product referral","pages":[{"title":"Track product page view for referral attribution.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/view","href":"/api-reference/track-product-page-view-for-referral-attribution"},{"title":"Track product share action.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/share","href":"/api-reference/track-product-share-action"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Create Destination","sidebarTitle":"Create Destination","href":"/api-reference/webhooks/create-destination"},{"title":"Test a Webhook","sidebarTitle":"Test a Webhook","href":"/api-reference/webhooks/test-webhook"},{"title":"Disable or Delete a Webhook Connection","href":"/api-reference/webhooks/disable-webhook"},{"title":"Events","href":"/api-reference/webhooks/events"},{"title":"Security","href":"/api-reference/webhooks/security"},{"title":"FAQ","href":"/api-reference/webhooks/faqs"}]}]},{"tab":"Changelog","icon":"newspaper","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"version":"Mention Me docs","tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":""}]},{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/knowledge-app/getting-started/overview"}]},{"tab":"Documentation","icon":"code","pages":[{"title":"Documentation","href":"/developer-docs/integration/overview"}]},{"tab":"API \u0026 Webhooks","icon":"square-terminal","groups":[{"group":"Getting Started","pages":[{"title":"API Reference","sidebarTitle":"Overview","href":"/api-reference/introduction"},{"title":"Environments","href":"/api-reference/getting-started/environments"},{"title":"Errors","href":"/api-reference/getting-started/errors"},{"title":"Rate Limits","href":"/api-reference/getting-started/rate-limits"}]},{"group":"Auth API","pages":[{"title":"Authentication","href":"/api-reference/authentication/overview"},{"title":"Create an API Key","href":"/api-reference/authentication/create-api-key"},{"title":"Getting an Access Token","href":"/api-reference/authentication/access-token"},{"title":"Scopes","href":"/api-reference/authentication/scopes"},{"group":"Auth","pages":[{"title":"Get access token","deprecated":null,"version":null,"openapi":"/openapi/auth_api.oas.json post /api/oauth/token","href":"/api-reference/auth/auth/get-access-token"}]}]},{"group":"Merchant API","pages":[{"title":"Overview","href":"/api-reference/merchant-api/overview"},{"title":"Your First Merchant API Request","href":"/api-reference/merchant-api/first-request"},{"group":"Coupons","pages":[{"title":"Validate coupon code","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json get /api/merchant/v2/coupons/validate/{coupon_code}","href":"/api-reference/merchant/coupons/validate-coupon-code"}]},{"group":"Customers","pages":[{"title":"Get customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers","href":"/api-reference/merchant/customers/get-customers"},{"title":"Purge customers","description":"Purge all customers matching the given identifiers.\n\nPurging is a permanent action. Once a customer is purged, they cannot be recovered.\n\nPurging is done on a queue. It may take some time for the customers to be purged. We recommend using the `GET /v2/customers` endpoint to determine if the customers have been purged. Approximate time to purge is\nnormally under \u003c 5 minutes, but can be several hours in some cases.\n\nCustomers who we were able to queue will be returned in the `accepted` array. Customers who we do not hold a record of or cannot find will be returned in the `errors` array.\n\n**Scopes:** `customers:delete`\n\n**Rate limits:** 300 requests per 5 minutes. Shared across all 'customers_purge' endpoints.","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json delete /api/merchant/v2/customers","href":"/api-reference/merchant/customers/purge-customers"},{"title":"Lapse customers","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/lapse","href":"/api-reference/merchant/customers/lapse-customers"},{"title":"Get customer rewards","description":"Returns all rewards a customer has been given.\n\nRewards that are fulfilled outside of Mention Me will not be returned.\n\n**Scopes:** `customers:read`, `rewards:read`\n\n**Rate limits:** 300 requests per 5 minutes. Shared across all 'rewards' endpoints.","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/customers/rewards","href":"/api-reference/merchant/customers/get-customer-rewards"}]},{"group":"Referee","pages":[{"title":"Referee cancellations","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/cancellation","href":"/api-reference/merchant/referee/referee-cancellations"},{"title":"Referee eligibility","deprecated":null,"version":null,"openapi":"/openapi/merchant_api.oas.json post /api/merchant/v2/referee/eligibility","href":"/api-reference/merchant/referee/referee-eligibility"}]}]},{"group":"Entrypoint API","pages":[{"title":"Overview","href":"/api-reference/entry-point-api/overview"},{"group":"Referrer promotion","pages":[{"title":"Referrer Promotion","href":"/api-reference/entry-point-api/referrer-promotion"},{"title":"Enrol a customer in an offer","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/offer","href":"/api-reference/referrer/enrol-a-customer-in-an-offer"}]},{"group":"Referee integration","pages":[{"title":"Referee Integration","href":"/api-reference/entry-point-api/referee-integration"},{"title":"Find a friend by name","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/referee","href":"/api-reference/referee/find-a-friend-by-name"}]},{"group":"Referrer dashboard","pages":[{"title":"Referrer Dashboard","href":"/api-reference/entry-point-api/referrer-dashboard"},{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/openapi/entrypoint_api.oas.json post /api/entry-point/{version}/dashboard","href":"/api-reference/dashboard/get-dashboard"}]},{"title":"Authentication Token","href":"/api-reference/entry-point-api/authentication-token"},{"title":"PostMessage Iframe Events","sidebarTitle":"PostMessage Iframe","href":"/api-reference/entry-point-api/postmessage"}]},{"group":"Consumer API","pages":[{"title":"Overview","href":"/api-reference/consumer-api/overview"},{"group":"Order tracking","pages":[{"title":"Order Tracking","href":"/api-reference/consumer-api/order-tracking"},{"title":"Record order","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/order","href":"/api-reference/record-order/record-order"},{"title":"Record order with a coupon","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/coupon_redemption","href":"/api-reference/record-order/record-order-with-a-coupon"}]},{"group":"Enrol referrer","pages":[{"title":"Enrol referrer","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referrer/enrol","href":"/api-reference/enrol-referrer/enrol-referrer"}]},{"group":"Referrer dashboard","pages":[{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/dashboard","href":"/api-reference/get-referrer-dashboard/get-dashboard"}]},{"group":"Find a friend","pages":[{"title":"Find a friend","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search","href":"/api-reference/find-referrer-by-name/find-a-friend"},{"title":"Find a friend content","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json get /api/consumer/{version}/referrer/search/content","href":"/api-reference/find-referrer-by-name/find-a-friend-content"}]},{"group":"Register referee","pages":[{"title":"Register referee","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/referee/register","href":"/api-reference/link-new-customer-to-referrer/register-referee"}]},{"group":"Product referral","pages":[{"title":"Track product page view for referral attribution.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/view","href":"/api-reference/track-product-page-view-for-referral-attribution"},{"title":"Track product share action.","deprecated":null,"version":null,"openapi":"/openapi/consumer_api.oas.json post /api/consumer/{version}/product/share","href":"/api-reference/track-product-share-action"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Create Destination","sidebarTitle":"Create Destination","href":"/api-reference/webhooks/create-destination"},{"title":"Test a Webhook","sidebarTitle":"Test a Webhook","href":"/api-reference/webhooks/test-webhook"},{"title":"Disable or Delete a Webhook Connection","href":"/api-reference/webhooks/disable-webhook"},{"title":"Events","href":"/api-reference/webhooks/events"},{"title":"Security","href":"/api-reference/webhooks/security"},{"title":"FAQ","href":"/api-reference/webhooks/faqs"}]}]},{"tab":"Changelog","icon":"newspaper","pages":[{"title":"Changelog","href":"/changelog"}]}]}]},"basePath":"","title":"Lapse customers - Mention Me Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}