Loyalty cards are not enabled by default. Please contact support to request the loyalty card feature.

Loyalty

List loyalty cards

Retrieve a list of all loyalty cards.

GET https://api.coupontools.com/v4/loyalty/loyalty-cards

Authentication:

API Keys

Example

Response

Copy loyalty card

Make a copy of a loyalty card.

POST https://api.coupontools.com/v4/loyalty/loyalty-cards/{id}/copy

Authentication:

API Keys

Parameters

Optional name String

New card name. Max. 50 characters

Example

Response

Loyalty users

Get user

Retrieve a list of all users connected to a loyalty card.

GET https://api.coupontools.com/v4/loyalty/loyalty-cards/{loyaltyCardId}/stats

Authentication:

API Keys

Parameters

Optional filter Object

Contains settings to filter the users.

Optional pagination Object

Contains settings to paginate the users.

Optional include_voided true | false

Toggle to include voided users

Example

Response

Get user

Retrieve all data from a single user.

GET https://api.coupontools.com/v4/loyalty/loyalty-cards/{loyaltyCardId}/stats/{userId}

Authentication:

API Keys

Example

Response

Create user

Create a single user with or without additional user data.

POST https://api.coupontools.com/v4/loyalty/loyalty-cards/{id}/stats

Authentication:

API Keys

Parameters

Optional first_name First name

Optional last_name Last name

Optional address Address

Optional zip Zip

Optional city City

Optional phone Phone

Optional email Email address

Optional custom_1 - custom_8 String

Custom value 1 through 8

Example

Response

Create users

Create a batch of users. Each user can contain additional user data.

POST https://api.coupontools.com/v4/loyalty/loyalty-cards/{id}/stats/bulk

Authentication:

API Keys

Parameters

Optional first_name First name

Optional last_name Last name

Optional address Address

Optional zip Zip

Optional city City

Optional phone Phone

Optional email Email address

Optional custom_1 - custom_8 String

Custom value 1 through 8

Example

Response

Update User

Update the data of a user.

POST https://api.coupontools.com/v4/loyalty/loyalty-cards/{loyaltyCardId}/stats/{userId}

Authentication:

API Keys

Parameters

Optional first_name First name

Optional last_name Last name

Optional address Address

Optional zip Zip

Optional city City

Optional phone Phone number

Optional email Email address

Optional custom_1 - custom_8 String

Custom value 1 through 8

Example

Response

Add stamps

Add stamps to a user's card.

POST https://api.coupontools.com/v4/loyalty/loyalty-cards/{loyaltyCardId}/stats/{userId}

Authentication:

API Keys

Parameters

Required amount Number

The amount of stamps that gets added to the user's card. Min. 1

Example

Response

Use rewards

Use rewards of a user.

PUT https://api.coupontools.com/v4/loyalty/loyalty-cards/{loyaltyCardId}/stats/{userId}/rewards

Authentication:

API Keys

Parameters

Required reward_ids List of reward ids

Example

Response

Void user

Void a user's card.

PUT https://api.coupontools.com/v4/loyalty/loyalty-cards/{loyaltyCardId}/stats/{userId}/void

Authentication:

API Keys

Example

Response

Delete user

Delete a user.

DELETE https://api.coupontools.com/v4/loyalty/loyalty-cards/{loyaltyCardId}/stats/{userId}

Authentication:

API Keys

Example

Notification

Send push notification

Send push notifications to (select) users.

POST https://api.coupontools.com/v4/loyalty/loyalty-cards/{id}/push-notifications

Authentication:

API Keys

Parameters

Required message String

Push notification message shown to the user.

Optional recipient_stat_ids List of user ids

List of user ids to send the push notification to. If not provided, the message will be send to all users.