v1

latestOpenAPI 3.0.02026-07-22207183.5 KB

Customers

Get customer rewards

Returns all rewards a customer has been given.

Rewards that are fulfilled outside of Mention Me will not be returned.

Scopes: customers:read, rewards:read

Rate limits: 300 requests per 5 minutes. Shared across all 'rewards' endpoints.

post/api/merchant/v2/customers/rewards

Request body

Response

The rewards issued to the customer matching the identifier.

Example response

{
  "data": {
    "customer": {
      "customerId": "CUST-1234",
      "email": "email@mention-me.com",
      "firstname": "Jane",
      "surname": "Doe",
      "phoneNumbers": [
        "+447123456789",
        "+447987654321"
      ],
      "profileUrl": "https://mention-me.com/merchant/123/customers/43211234"
    },
    "rewards": [
      {
        "amount": 100,
        "spendConstraint": 50,
        "callToActionUrl": "https://www.your-website.com/new-customer-welcome",
        "couponCode": "ABC-DEF-1234",
        "couponLink": "https://www.your-website.com/redeem?code=ABC-DEF-1234",
        "securityCode": "12345"
      }
    ]
  }
}