Update affiliate
Updates the specified affiliate by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Updates the specified affiliate by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Request

Method
URL
PUT
https://api.getrewardful.com/v1/affiliates/:id

Parameters

Parameter
Required?
Description
first_name
No
The affiliate's first name.
last_name
No
The affiliate's last name.
email
No
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.
campaign_id
No
The UUID of the campaign this affiliate should be moved to. Learn more about moving affiliates between campaigns.
paypal_email
No
The PayPal address that commissions should be paid to.
wise_email
No
The Wise address that commissions should be paid to.
receive_new_commission_notifications
No
Whether or not the affiliate should receive emails when new rewards and commissions are earned. Accepts true or false.

Example

curl --request PUT \
--url https://api.getrewardful.com/v1/affiliates/d0ed8392-8880-4f39-8715-60230f9eceab \
-u YOUR_API_SECRET: \
-d first_name=Jamie \

Response

Success
Failures
Response code
Body
200

Not found

Response code
Body
404
JSON object describing the error.
{ "error": "Affiliate not found: " }

Authentication failure

Response code
Body
401
Description of the authentication failure.
{ "error": "Invalid API Secret." }
Export as PDF
Copy link