Skip to main content
POST
/
claim-tokens
Rewards
curl --request POST \
  --url https://tokens.shakesco.com/claim-tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_name": "<string>",
  "email": "<string>",
  "amount": 123
}
'
{
  "tx_hash": "0xabc123..."
}

Documentation Index

Fetch the complete documentation index at: https://docs.shakesco.com/llms.txt

Use this file to discover all available pages before exploring further.

For the complete documentation index, see llms.txt. These endpoints let your backend award tokens when customers complete events, spend them for redemptions, and expire stale balances.
All write endpoints submit an on-chain transaction and return a tx_hash. Base URL: https://tokens.shakesco.com

POST /claim-tokens

Award tokens to a customer for completing an event (e.g. signup, purchase, birthday). Events and their token allocations are configured on your BusinessToken contract or from the dashboard.

Request Body

event_name
string
required
The event identifier (must match an event configured on your contract)
email
string
required
Customer’s email address

Response

tx_hash
string
On-chain transaction hash
{
  "tx_hash": "0xabc123..."
}

POST /redeem-tokens

Deduct tokens from a customer when they redeem a reward. Tokens are returned to the business contract.

Request Body

email
string
required
Customer’s email address
amount
number
required
Number of tokens to redeem (e.g. 5 or 1.5)
{
  "tx_hash": "0xdef456..."
}

POST /expire-tokens

Expire all tokens for a customer who has exceeded the inactivity period set on your token contract.

Request Body

email
string
required
Customer’s email address
{
  "tx_hash": "0xghi789..."
}

POST /claim-pending-rewards

Generate a URL that lets a customer claim pending rewards directly. Returns a short-lived link (10 minutes) that the customer opens in the Shakesco app.

Request Body

email
string
required
Customer’s email address

Response

url
string
The claim URL to send to the customer
expires_at
string
ISO 8601 expiry time (10 minutes from creation)
{
  "url": "https://send.shakesco.com/send-token/eyJ...",
  "expires_at": "2026-05-13T12:10:00.000Z"
}