SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Affiliates

Issue a referral link for a partner

Issue a referral link that records each click, remembers the visitor and forwards them to the destination with the partner code attached. Link names are shared by every workspace, so when the slug you ask for is taken or not valid a free one is chosen for you. A partner can have up to 50 links (409 too_many_links).

POSThttps://app.softsolz.uk/api/v1/services/affiliates/affiliates/{affiliateId}/links

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

affiliateIdstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

destination_urlstringrequired

Public http or https page the visitor lands on.

slugstring

Short name for the link address: 3 to 40 lower-case letters, numbers and dashes. Defaults to the partner code.

campaignstring | null

Campaign label for reporting.

Response

Response Body

idstringReferral link id.
affiliate_idstringPartner the link belongs to.
slugstringShort name used in the link address.
urlstringThe referral link to share. It records the click and forwards to the destination.
destination_urlstringWhere the visitor lands after the click.
campaignstring | nullCampaign label for reporting, or null.
click_countintegerClicks recorded on this link.
last_click_atstring | nullWhen the link was last clicked, or null.
created_atstringWhen the link was issued.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/affiliates/affiliates/{affiliateId}/links \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"destination_url": "https://www.example.com/pricing",
"slug": "acme-media",
"campaign": "spring-launch"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
"data": {
"id": "7",
"affiliate_id": "12",
"slug": "acme-media",
"url": "https://app.softsolz.uk/ref/acme-media",
"destination_url": "https://www.example.com/pricing",
"campaign": "spring-launch",
"click_count": 0,
"last_click_at": null,
"created_at": "2026-10-01T10:20:00.000Z"
}
}