Invite Friends via Mobile Number

This API is designed for scenarios where the referrer knows their friend's mobile number and wants to send them an invitation. For example, an existing customer can enter their friend's mobile number to invite them. This action will also create an account for the friend on the host platform (e.g., Shopify). This functionality is available exclusively for Shopify brands.

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

(Required) (This needs to 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
required

(Required) (This can only be one of mobile,unix,web)

string
required

(Required) (This needs to be your apikey)

string
required

(Required) (This needs to be your workspaceid)

Response
200

200

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!