Create affiliate

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

This endpoint allows merchants to create affiliates on demand.

Both normal affiliates and customer referrers can be created through this endpoint. To create a customer referrer, simply pass the stripe_customer_id parameter that indicates the Stripe Customer that should receive account credits as rewards.

Rewardful does not send a "Welcome Email" or require email confirmation for affiliates created through the REST API. If you would like to send a "Welcome Email" to these affiliates, you can do so from your application after making the API call, respond to the affiliate.created webhook, or configure on of our email integrations.

Request

Method

URL

POST

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

Parameters

Parameter

Required?

Description

first_name

Yes

The affiliate's first name.

last_name

Yes

The affiliate's last name.

email

Yes

The affiliate's email address.

state

No

A string indicating the affiliate's state. Defaults to active.

stripe_customer_id

No

For customer referral programs, this is the Stripe Customer that will receive account credits as rewards. Note: the customer must exist in your Stripe account in livemode.

token

No

Alphanumeric code to be used for links, ex: ?via=token Must contain only letters, numbers, and dashes.

campaign_id

No

The UUID of the campaign this affiliate should be added to. Affiliate will be added to your default campaign if this parameter is

blank.

receive_new_commission_notifications may also be optionally provided. This parameter indicates whether or not the affiliate should receive emails when new rewards and commissions are earned. Accepts true (default) or false.

Example

curl --request POST \
--url https://api.getrewardful.com/v1/affiliates \
-u YOUR_API_SECRET: \
-d first_name=James \
-d last_name=Bond \
-d email=[email protected] \
-d token=jb007 \
-d stripe_customer_id=cus_ABC123

Response

Success
Failures
Success

Response code

Body

200

An affiliate object (JSON)

Failures

Invalid parameters

Response code

Body

422

JSON object describing validation errors.

{
"error": "Could not create affiliate.",
"details": ["Email can't be blank"]
}

Authentication failure

Response code

Body

401

Description of the authentication failure.

{ "error": "Invalid API Secret." }