Superfiliate

Enroll a customer in a gifting campaign

Bearer auth

Enrolls an existing Superfiliate customer in an active seeding/gifting campaign. Use a gifting campaign ID from GET /api/v1/gifting_campaigns, not a program ID from /campaigns. Affiliate program enrollment is not required. Shopify and merchant-managed campaigns are supported.

Repeating a request returns the customer's latest existing gift in this campaign, including claimed, expired, or canceled gifts, without changing it or sending another gift. Recurrence remains managed by the campaign's existing schedule; this endpoint does not manually refresh gifts.

New manual gifts are unlocked. Automatic Shopify gifts enter ready_to_send when an address exists, or missing_address otherwise. Adding a customer does not immediately place a Shopify order. Existing gifting automations run for new additions only.

Requires explicitly granted gifting_campaigns.write; existing API keys gain no new permission. Returns 404 for a customer or campaign outside the credential's shop, and 422 for inactive campaigns.

POSTapi.superfiliate.com/api/dry-run/v1/gifting_campaigns/{id}/enroll

Path parameters1

idrequired
integer
Superfiliate gifting campaign ID

Body parametersapplication/json

  • customer_idintegerrequired

    Superfiliate customer ID

Responses

The new or existing gift

  • idinteger

    Gift/reward ID

  • customer_idinteger

    Identifier for the related customer.

  • gifting_campaign_idinteger

    Identifier for the related gifting campaign.

  • statusenum<string>

    Current status of this resource.

    "unlocked""claimed""shipped""delivered""expired""paused""skipped""not_eligible""pending""error""ready_to_send""missing_address""order_placed""canceled"