Get Signup Program

curl https://api.thanxsandbox.com/signup_programs/welcome-reward \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "X-ClientId: ${client_id}"

{
  "program": {
    "id": "awe833ke24",
    "merchant_id": "ghwou3457f",
    "name": "Welcome Reward",
    "handle": "welcome-reward",
    "redeem": {
      "type": "manual",
      "text": "$5 off your next purchase",
      "detail": "Use this reward on your next visit",
      "window": 60,
      "venue": "all"
    }
  }
}

GET

signup_programs

:handle

curl https://api.thanxsandbox.com/signup_programs/welcome-reward \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "X-ClientId: ${client_id}"

{
  "program": {
    "id": "awe833ke24",
    "merchant_id": "ghwou3457f",
    "name": "Welcome Reward",
    "handle": "welcome-reward",
    "redeem": {
      "type": "manual",
      "text": "$5 off your next purchase",
      "detail": "Use this reward on your next visit",
      "window": 60,
      "venue": "all"
    }
  }
}

This endpoint returns a specific active signup program identified by its handle. If the program is not found or not accessible, a 404 error is returned.

This endpoint is publicly accessible and does not require authentication. Programs are filtered based on the OAuth application context.

Parameters

handle

string

required

The URL-friendly handle of the signup program

Response

string

Program ID

merchant_id

string

Merchant ID

name

string

Program name (reward template name or program name)

handle

string

URL-friendly handle for the program

redeem

object

Details of how the reward can be redeemed

Show redeem

type

enum

How the reward can be redeemed (manual, automatic, experience, points)

text

string

Description of the reward

detail

string

Long description of the reward

venue

string

Where the reward can be used: (instore, online, all)

window

integer

Number of minutes the reward is available for use after activation

curl https://api.thanxsandbox.com/signup_programs/welcome-reward \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "X-ClientId: ${client_id}"

{
  "program": {
    "id": "awe833ke24",
    "merchant_id": "ghwou3457f",
    "name": "Welcome Reward",
    "handle": "welcome-reward",
    "redeem": {
      "type": "manual",
      "text": "$5 off your next purchase",
      "detail": "Use this reward on your next visit",
      "window": 60,
      "venue": "all"
    }
  }
}

Get Signup Programs Get Tags

⌘I

Consumer API

Reference

Get Signup Program

Parameters

Response

​Parameters

​Response

Parameters

Response