Comment on page

Create affiliate link

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

Creating additional affiliate links is only available on Growth and Enterprise plans.
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
Success
Failures
Response code
Body
200
An affiliate link object (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
Response code
Body
401
Description of the authentication failure.
{  "error": "Invalid API Secret." }

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.

Response code	Body
200	An affiliate link object (JSON)

List affiliate links

Retrieve affiliate link

Last modified 1yr ago

Method	URL
`POST`	`https://api.getrewardful.com/v1/affiliate_links`

Response code	Body
`422`	JSON object describing validation errors.

Response code	Body
`401`	Description of the authentication failure.