Superfiliate

Create customer

Bearer authcustomers.write

Creates a customer when the email is new. If the customer already exists, supplied non-blank profile fields update the existing customer before it is returned.

POSTapi.superfiliate.com/api/v1/customers

Body parametersapplication/json

  • emailstringrequired

    Email address for this person.

  • first_namestring

    Single-line name; whitespace is normalized before persistence. HTTP(S) URLs and control characters are rejected

  • last_namestring

    Single-line name; whitespace is normalized before persistence. HTTP(S) URLs and control characters are rejected

  • instagram_handlestring

    The instagram handle for this resource.

  • tiktok_handlestring

    The tiktok handle for this resource.

  • phonestring

    Phone number for this person.

Responses

The customer. If the email already existed, the existing customer is returned unchanged.

  • 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