Sign in

v1

latestOpenAPI 3.1.02026-07-14460151.1 KB

Generate a private link

Create a unique, trackable redemption URL for a specific recipient. This endpoint allows you to associate a landing page with a user's email address and optionally trigger an automated delivery email. Note: This action is only supported for pages where the type is set to private; attempting this on a public-type page will result in a validation error.

post/v2/redeem-pages/{id}/private-links

Path parameters

idstring required

ID of the redeem page

Request body

first_namestring

The recipient's first name.

last_namestring

The recipient's last name or surname.

emailstring required

A valid email address. This serves as the unique identifier for the link recipient and is used for delivery if send_email is enabled.

send_emailboolean

If set to true, the system will automatically trigger a delivery email to the recipient containing their unique redemption link. Defaults to false

Response

201

Example response

{
  "data": {
    "id": 28,
    "uuid": "CwewnXzOzzXv",
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@gmail.com",
    "status": "Unredeem",
    "link": "http://localhost:8000/redeem/aaaf28e9-ed04-47e2-b0c3-c6a41e6304de/CwewnXzOzzXv"
  }
}