curl --request POST \
--url https://mention-me.com/api/merchant/v2/customers/lapse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifiers": [
{
"type": "email",
"value": ""
}
]
}
'{
"accepted": [
{
"type": "email",
"value": ""
}
],
"errors": [
{
"value": "<string>",
"reason": "notFound"
}
]
}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.
curl --request POST \
--url https://mention-me.com/api/merchant/v2/customers/lapse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifiers": [
{
"type": "email",
"value": ""
}
]
}
'{
"accepted": [
{
"type": "email",
"value": ""
}
],
"errors": [
{
"value": "<string>",
"reason": "notFound"
}
]
}Authorizations
RFC8725 Compliant JWT
Body
A collection of identifiers for customers in Mention Me.
Maximum of 100 identifiers.
1 - 100 elements- Option 1
- Option 2
Show child attributes
Show child attributes
Response
All identifiers that were queued to be marked as lapsed.
A collection of customer identifiers which were accepted, or resulted in an error.
Was this page helpful?