LogoLogo
REST APIWebhooksHelp Center →
  • Introduction
  • JavaScript API
    • Overview
  • REST API
    • Overview
    • Campaigns
      • The campaign object
      • List campaigns
      • Create campaign
      • Retrieve campaign
      • Update campaign
    • Affiliates
      • The affiliate object
      • List affiliates
      • Create affiliate
      • Retrieve affiliate
      • Update affiliate
      • Magic Link (SSO)
    • Affiliate Links
      • The affiliate link object
      • List affiliate links
      • Create affiliate link
      • Retrieve affiliate link
      • Update affiliate link
    • Affiliate Coupons
      • The affiliate coupon object
      • List affiliate coupons
      • Create affiliate coupon
      • Retrieve affiliate coupon
    • Referrals
      • The referral object
      • List referrals
    • Commissions
      • The commission object
      • List commissions
      • Retrieve commission
      • Update commission
      • Delete commission
    • Payouts
      • The payout object
      • List payouts
      • Retrieve a payout
      • Mark a payout as paid
  • Webhooks
    • Overview
    • Endpoints
    • Requests
    • Event types
    • Signed webhooks
  • Links
    • Help Center
    • Sign up
    • Login
    • Learn more about Rewardful
Powered by GitBook
On this page
  • Request
  • Parameters
  • Example
  • Response

Was this helpful?

Export as PDF
  1. REST API
  2. Affiliate Links

Create affiliate link

Creates a new affiliate link in your account with the specified parameters.

PreviousList affiliate linksNextRetrieve affiliate link

Last updated 1 year ago

Was this helpful?

Creating additional affiliate links is only available on .

Request

Method

URL

POST

https://api.getrewardful.com/v1/affiliate_links

Parameters

Parameter
Required?
Description

affiliate_id

Yes

The ID of the affiliate this link should be associated with.

token

No

Alphanumeric code to be used for this link. Must contain only letters, numbers, and dashes. A unique token will be generated if this parameter is left blank.

Example

curl --request POST \
  --url https://api.getrewardful.com/v1/affiliate_links \
  -u YOUR_API_SECRET: \
  -d affiliate_id=f46a912b-08bc-4332-8771-c857e11ad9dd \
  -d token=luke-skywalker

Response

Response code
Body

200

An (JSON)

Invalid parameters

Response code

Body

422

JSON object describing validation errors.

{
  "error": "Could not create affiliate link.",
  "details": ["Token is already in use."]
}

Authentication failure

401

Description of the authentication failure.

{  "error": "Invalid API Secret." }
Growth and Enterprise plans
affiliate link object