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 |
|
|
Parameters
Parameter | Required? | Description |
| Yes | The affiliate's first name. |
| Yes | The affiliate's last name. |
| Yes | The affiliate's email address. |
| No | A string indicating the affiliate's state. Defaults to |
| 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. |
| No | Alphanumeric code to be used for links, ex: |
| 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. |
| No | The PayPal address that commissions should be paid to. |
| No | The Wise address that commissions should be paid to. |
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
Response
Response code | Body |
200 | An affiliate object (JSON) |
Last updated