Skip to main content
The clickthrough endpoint records when a user clicks on an affiliate product offer. Call this endpoint before redirecting the user to the affiliate product page to ensure the click is attributed to your program.

Endpoint

POST /clickthrough/{convo_id}
No authentication required.

Path Parameters

convo_id
string
required
The conversation session ID associated with this click event.

Request Body (ProductClick)

program
string
required
Your loyalty program identifier.
email
string
required
The user’s email address.
convo_id
string
required
The conversation session ID. Should match the path parameter.
presentation_id
string
required
The offer presentment identifier.
click_id
string
required
A unique identifier for this click event.
click_datetime
string
required
ISO 8601 timestamp of when the click occurred.
product_info
object
Optional product information associated with this click.

Example Request

curl -X POST https://rewardsbot-prod.liquidrewardsapi.com/clickthrough/session-abc123 \
  -H "Content-Type: application/json" \
  -d '{
    "program": "my-loyalty-program",
    "email": "user@example.com",
    "convo_id": "session-abc123",
    "presentation_id": "pres-001",
    "click_id": "click-abc123",
    "click_datetime": "2024-01-15T10:30:00Z"
  }'

Response

Returns HTTP 202 Accepted on success. The body is empty.

Error Responses

StatusDescription
422 Unprocessable EntityValidation error in request body
Record clicks before redirecting the user. Missing click events may result in unattributed affiliate commissions.