Skip to main content
The signup endpoint records when a user enrolls in a loyalty or rewards program during a shopping session. Linking signups to conversation sessions and product context enables accurate attribution and reporting.

Endpoint

POST /signup/{convo_id}
No authentication required.

Path Parameters

convo_id
string
required
The conversation session ID associated with this signup.

Request Body (SignupSubmission)

program
string
required
Your loyalty program identifier.
email
string
required
The user’s email address.
presentation_id
string
The offer presentment ID that prompted this signup.
card_bin
string
First 6 digits of the user’s payment card BIN. Used for card-linked offer programs.
external_id
string
Your internal user identifier for cross-referencing.
utm
object
UTM attribution parameters as a key-value map of strings (e.g., utm_source, utm_medium, utm_campaign).
product_info
object
Product information associated with this signup.

Example Requests

curl -X POST https://rewardsbot-prod.liquidrewardsapi.com/signup/session-abc123 \
  -H "Content-Type: application/json" \
  -d '{
    "program": "my-loyalty-program",
    "email": "user@example.com"
  }'

Response

Returns HTTP 202 Accepted on success.

Error Responses

StatusDescription
422 Unprocessable EntityValidation error