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

    API Changelog

    [2026-07-17] v2#

    Added#

    [Affiliate] Get connected customer list
    Added a new endpoint to get the list of customers connected to affiliates of the store.
    Endpoint: GET /api/v2/connected-customers
    Impact: Minor (new endpoint, no breaking changes)
    More details: Read docs
    [Affiliate] Delete a customer connection
    Added a new endpoint to delete a customer connection (disconnect a customer from an affiliate) by affiliate_id and customer_id.
    Endpoint: DELETE /api/v2/connected-customers
    Impact: Minor (new endpoint, no breaking changes)
    More details: Read docs

    [2026-07-06] v2#

    Change#

    [Payment] Get paid/unpaid payments + Get payment by ID + Payment.paid webhook
    Added referral_ids field
    Endpoint: GET /v2/payments/unpaid, GET /v2/payments/paid, GET /v2/payments/{id}, and the payment.paid webhook
    Impact: Minor (new optional fields added to existing endpoints & webhook, no breaking changes)

    [2026-03-04] v2#

    Change#

    [Affiliate] Get list affiliates
    Added 2 new fields w9_form, internal_note
    Endpoint: GET /api/v2/affiliates
    Impact: Minor (new optional fields added to existing endpoints, no breaking changes)
    More details: Read docs
    [Affiliate] Get affiliate by ID
    Added 2 new fields w9_form, internal_note
    Endpoint: GET /api/v2/affiliates/{id}
    Impact: Minor (new optional fields added to existing endpoints, no breaking changes)
    More details: Read docs
    [Affiliate] Create an affiliate
    Added new fields internal_note
    Endpoint: POST /api/v2/affiliates
    Impact: Minor (new optional fields added to existing endpoints, no breaking changes)
    More details: Read docs

    [2026-02-23] v2#

    Added#

    [Program] Get list programs
    Added a new endpoint to get list programs.
    Endpoint: GET /api/v2/programs
    Impact: Minor (new endpoint, no breaking changes)
    More details: Read docs
    [Program] Get program by ID
    Added a new endpoint to get program details by ID.
    Endpoint: GET /api/v2/programs/{id}/
    Impact: Minor (new endpoint, no breaking changes)
    More details: Read docs
    [Program] Get excluded products/collections
    Added a new endpoint to get list excluded products/collections of a program by ID.
    Endpoint: GET /api/v2/referral/{id}/excluded
    Impact: Minor (new endpoint, no breaking changes)
    More details: Read docs

    [2026-02-10] v2#

    Added#

    [Affiliate] Add website, tiktok, and personal_detail fields
    Added 3 new fields to the Affiliate entity: website, tiktok, and personal_detail.
    Create Affiliate, list affiliate, get detail affiliate by id
    website (string, max 300 chars)
tiktok (string, max 60 chars)
personal_detail (string, max 1000 chars)
    Impact: Minor (new optional fields added to existing endpoints, no breaking changes)
    More details: Read docs

    [2026-02-02] v2#

    Change#

    [Affiliate] create an affiliate
    Added a new option status: pending to API: create an affiliate.
    Endpoint: POST /api/v2/affiliates
    Impact: Minor (no breaking changes)
    More details: Read docs

    [2026-01-28] v2#

    Added#

    [Referral] Approve / Deny referral
    Added a new endpoint to update the status of a referral (review referral) by ID.
    Endpoint: POST /api/v2/referral/{id}/status
    Impact: Minor (new endpoint, no breaking changes)
    More details: Read docs
    Modified at 2026-07-17 10:23:43
    Previous
    API Overview
    Next
    Get programs
    Built with