Copy Page
UpPromote Public API
API Overview
API Changelog
Program
Get programs
GET
Get a program by ID
GET
Get excluded products/collections of a program
GET
Affiliate
Get affiliates
GET
Get affiliate by ID
GET
Create an affiliate
POST
Approve/Deny affiliate
POST
Set upline for an affiliate
POST
Move an affiliate to a program
POST
Get connected customer list
GET
Connect a customer to an affiliate
POST
Delete a customer connection
DELETE
Coupon
Get coupons
GET
Assign a coupon to an affiliate
POST
Payment
Get unpaid payments
GET
Get paid payments (History)
GET
Count total paid payments
GET
Get a payment by ID
GET
Mark as paid a manual payment
POST
Referral
Get list referrals
GET
Get a referral by ID
GET
Approve/Deny referral
POST
Create a referral
POST
Add referral adjustment
POST
Webhook
Get webhook subscriptions
Subscribe a webhook event
Update a webhook subscription
Delete a webhook subscription
Webhook Event Payload
Webhook overview
Referral new
Referral approved
Referral denied
Referral status changed
Affiliate new
Affiliate approved
Affiliate inactive
Affiliate status changed
Payment paid
Schemas
ConnectedCustomer
ErrorEnvelope
ValidationErrorEnvelope
ValidationErrorEnvelope
Copy Page
{
"status"
:
422
,
"message"
:
{
"property1"
:
[
"string"
]
,
"property2"
:
[
"string"
]
}
,
"data"
:
[
]
}