API Reference
  1. API reference
  2. Referral APIs

Claim Referral Code via Email

post
https://platform.nector.io/api/v2/merchant/leads-referral-via-email

This API is intended for situations where the referee has their friend's referral code. For example, an existing customer shares their referral code with friends, enabling them to sign up. This process also creates an account for the referee on the host platform (e.g., Shopify or WooCommerce).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

(Required) (This needs to be leads referral_code value of the customer who is referring)

string
required

(Required) (Maximum length is 200) (This needs to be the name of the user who is getting referred)

metadetail
object
Headers
string
enum
required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:
string
required

(Required) (This needs to be your apikey)

string
required

(Required) (This needs to be your workspaceid)

Responses

Updated about 1 month ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?