Superfiliate

Enroll a customer

Bearer authcustomers.write

Enrolls a customer to a campaign, if not already enrolled to a campaign.

Pass campaign_id to enroll the customer in any campaign that belongs to the shop. If omitted, the shop's default campaign is used.

If the customer is already enrolled to a campaign, it just returns the customer data.

POSTapi.superfiliate.com/api/v1/customers/{id}/enroll

Path parameters1

idrequired
integer
—

Body parametersapplication/json

  • codestring

    Code associated with this resource.

  • campaign_idinteger

    ID of any campaign that belongs to the shop. If omitted, the shop's default campaign is used.

  • code_activationenum<string>

    The code strategy to use. "create" will try to create a new code for the customer, using the specified code. If not available, it will append random characters until the code is available. "link" will ignore code's creation and just assume the code already exists in Shopify. "override" will try to create the specified code. If the specified code is not available, it will delete that existing code and create under the campaign settings.If this option is not specified, it will default to "create".

    "create""link""override"

Responses

The enrolled customer

  • idinteger
  • emailstring

    Email address for this person.

  • phonestring | null

    Phone number for this person.

  • first_namestring | null

    Person's given name.

  • last_namestring | null

    Person's family name.

  • instagram_handlestring | null

    The instagram handle for this resource.

  • tiktok_handlestring | null

    The tiktok handle for this resource.

  • balancestring

    Store credit amount in wallet. Eg. "12.3", meaning $12.30

  • codestring | null

    May be blank if customer is not enrolled yet. Public, to share with friends/followers

  • microsite_urlstring | null

    May be blank if customer is not enrolled yet. Public, to share with friends/followers

  • reward_codestring | null

    May be blank if customer is not enrolled yet. Private, to redeem their wallet balance.

  • redeem_urlstring | null

    May be blank if customer is not enrolled yet. Private, to redeem their wallet balance.

  • campaign_idinteger | null

    May be blank if customer is not enrolled yet.

  • enrolled_atstring | null

    ISO8601 timestamp when customer was enrolled. May be blank if customer is not enrolled yet.

  • tagsarray of strings

    Customer tags added via the admin app