Superfiliate

Dry-run API Reference

Campaigns / Programs

A Program is the merchant-facing configuration for a partnership, including eligibility, offers, attribution behavior, and commission rules. The Partner API uses the legacy campaigns resource name for these program records.

Response blueprint

Fields returned by dry-run fixtures. Expand nested objects to inspect their fields.

array of objects — item fields

  • idinteger

    Eg. 12345

  • namestring

    Eg. "Referral & Loyalty", "Creators TikTok Winter"

  • statusstring

    Eg. "active", "finished", "draft"

  • audience_typestring

    Eg. "loyalty", "creators"

  • The campaign reward for this resource.

      • lead_reward_unitstring

        The lead reward unit for this resource.

      • lead_reward_valuenumber

        The lead reward value for this resource.

      • minimum_subtotal_valuestring

        The minimum subtotal value for this resource.

      • lead_discount_typestring

        The lead discount type for this resource.

      • lead_minimum_quantityintegernull

        The lead minimum quantity for this resource.

      • lead_minimum_subtotal_typestring

        The lead minimum subtotal type for this resource.

      • lead_discount_new_customers_onlyboolean

        The lead discount new customers only for this resource.

      • lead_entitled_quantityintegernull

        The lead entitled quantity for this resource.

      • lead_discount_buy_modalitystring

        The lead discount buy modality for this resource.

    • option 2null

Endpoints

GETList campaigns/api/dry-run/v1/campaigns