Links

Create a link

A destination plus a tracking value. The value defaults to the partner's handle; a custom value must be unique in the program.

Scope: partners:write (or write)

post/v1/links

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/links
  • Auth: HTTP bearer

Request body

program_idstring required

Prefixed id (prg_…)

partner_idstring required

Prefixed id (part_…)

destination_urlstring uri required
valuestring

The tracking value; defaults to the partner's handle

paramstring
labelstring

Example request

{
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "partner_id": "part_7uSyy9FqVLCFWrdPeZaK"
}

Response

The new link

idstring required

Prefixed id (lnk_…)

object'link' required
partner_idstring required

Prefixed id (part_…)

paramstring required
valuestring required
destination_urlstring required
urlstring required

The destination with the tracking parameter applied

short_urlstring nullable required
short_slugstring nullable required
short_domainstring nullable required
labelstring nullable required
rate_overrideunknown
created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "lnk_7uSyy9FqVLCFWrdPeZaK",
  "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.