UpPromote Public API
    UpPromote Public API
    • API overview
    • 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
      • Connect a customer to an affiliate
        POST
    • 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
      • Create a referral
        POST
      • Add referral adjustment
        POST
    • Webhook
      • Get webhook subscriptions
        GET
      • Subscribe a webhook event
        POST
      • Update a webhook subscription
        PUT
      • Delete a webhook subscription
        DELETE
    • Webhook Event Payload
      • Webhook overview
      • Referral new
        POST
      • Referral approved
        POST
      • Referral denied
        POST
      • Referral status changed
        POST
      • Affiliate new
        POST
      • Affiliate approved
        POST
      • Affiliate inactive
        POST
      • Affiliate status changed
        POST
      • Payment paid
        POST

    API overview

    đź’ˇ
    API v1 is the legacy version. We suggest that you should use v2 for up-to-date features.
    UpPromote Public API v2 uses API keys. Every request must include your key in the headers. Requests without a valid key are rejected.
    Header: Authorization: <YOUR_API_KEY>
    Content type: JSON only
    TLS: HTTPS is required
    Your API key is an opaque string. Treat it like a password—store securely and rotate regularly.

    1. How to get API Key?#

    Open UpPromote app > Select Settings > Integrations > Scroll down & find API Key
    image.png
    Select Get API Key and copy the API Key
    image.png

    2. Base URLs#

    https://aff-api.uppromote.com/api/v2

    3. Required Headers#

    HeaderExampleDescription
    AuthorizationAuthorization: xxxxxxxxxxxxxxYour API key
    Acceptapplication/jsonAsk for JSON responses.
    Content-Typeapplication/jsonSend JSON when there’s a request body.

    4. API Rate limit#

    Each store can make 120 requests per minute across all v2 endpoints.
    Scope: per-store (not per key, user, or IP)
    Window: fixed 60-second windows
    What counts: every successful or failed API call (HTTP 2xx–5xx). Webhook deliveries don’t count toward this limit.
    Modified at 2025-09-29 08:36:35
    Next
    Get affiliates
    Built with