{"items":[{"type":"link","label":"Refer a Friend V3 APIs","link":"/raf/raf","routeSlug":"/raf/raf","content":{"contentType":"overview","meta":{"name":"Refer a Friend V3 APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"raf.json","url":"/_bundle/raf/raf.json?download"},{"kind":"download","label":"raf.yaml","url":"/_bundle/raf/raf.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://s2.socialannex.net/api/"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Refer a Friend V3 APIs (3.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Thank you for choosing our Refer a Friend API to enhance your application's referral capabilities. This comprehensive documentation is designed to guide you through the seamless integration of our powerful referral system into your platform, allowing your users to effortlessly refer friends and unlock a world of rewards. Our team is committed to providing excellent developer support, so if you encounter any challenges or have any questions, please don't hesitate to reach out to us. We want to ensure that your experience with the Refer a Friend API is seamless and successful. So, let's get started and unlock the full potential of referral marketing together. A detailed explanation of the Refer a Friend User API and the examples are shown below."}],"sectionId":"/raf/raf"}],"sectionId":"/raf/raf"}]}]}},{"type":"group","label":"User","link":"/raf/raf/user","routeSlug":"/raf/raf/user","items":[{"label":"Create a new user account under a specific site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecodecoupon","routeSlug":"/raf/raf/user/invitecodecoupon","metadata":{"seo":{"title":"Create a new user account under a specific site","description":"This POST endpoint allows you to create a new user account under a specific site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvitecodeCoupon","name":"Create a new user account under a specific site","isWebhook":false,"pointer":"/paths/~1createuser~1{{siteId}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new user account under a specific site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This POST endpoint allows you to create a new user account under a specific site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304","pointer":"/paths/~1createuser~1{{siteId}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/createuser/{{siteId}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_304"}},"responseCodes":["200"],"pointer":"/createuser/{{siteId}}?access_token={{access_token}}","href":"user/invitecodecoupon","openApiOperationId":"InvitecodeCoupon","summary":"Create a new user account under a specific site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createuser"},"application/xml":{"schemaId":"components/schemas/createuser"}},"schemaId":"components/schemas/createuser"}],"pointer":"/paths/~1createuser~1{{siteId}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/createuser","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createuser"},"application/xml":{"schemaId":"components/schemas/createuser"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/invitecodecoupon"}],"panels":[]}]},"httpPath":"/createuser/{{siteId}}?access_token={{access_token}}"},{"label":"Get referral status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecode","routeSlug":"/raf/raf/user/invitecode","metadata":{"seo":{"title":"Get referral status","description":"This API is used to get the referral status of the referee (the friend who was referred by a member)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invitecode","name":"Get referral status","isWebhook":false,"pointer":"/paths/~1Referralstatus~1{{siteId}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get referral status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API is used to get the referral status of the referee (the friend who was referred by a member)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305"}},"schemaId":"schema_305","pointer":"/paths/~1Referralstatus~1{{siteId}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/Referralstatus/{{siteId}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_305"}},"responseCodes":["200"],"pointer":"/Referralstatus/{{siteId}}?access_token={{access_token}}","href":"user/invitecode","openApiOperationId":"invitecode","summary":"Get referral status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_305","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/userDetails"},"application/xml":{"schemaId":"components/schemas/userDetails"}},"schemaId":"components/schemas/userDetails"}],"pointer":"/paths/~1Referralstatus~1{{siteId}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/userDetails","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/userDetails"},"application/xml":{"schemaId":"components/schemas/userDetails"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/invitecode"}],"panels":[]}]},"httpPath":"/Referralstatus/{{siteId}}?access_token={{access_token}}"},{"label":"Create or Assign a new invite code coupon for a specific site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecodecoupon","routeSlug":"/raf/raf/user/invitecodecoupon","metadata":{"seo":{"title":"Create or Assign a new invite code coupon for a specific site","description":"This API is used to unlock the coupon code for the referee/friend."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"InvitecodeCoupon","name":"Create or Assign a new invite code coupon for a specific site","isWebhook":false,"pointer":"/paths/~1Invitecodecoupon~1{{siteId}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or Assign a new invite code coupon for a specific site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API is used to unlock the coupon code for the referee/friend."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304","pointer":"/paths/~1Invitecodecoupon~1{{siteId}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/Invitecodecoupon/{{siteId}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_304"}},"responseCodes":["200"],"pointer":"/Invitecodecoupon/{{siteId}}?access_token={{access_token}}","href":"user/invitecodecoupon","openApiOperationId":"InvitecodeCoupon","summary":"Create or Assign a new invite code coupon for a specific site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createuser"},"application/xml":{"schemaId":"components/schemas/createuser"}},"schemaId":"components/schemas/createuser"}],"pointer":"/paths/~1Invitecodecoupon~1{{siteId}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/createuser","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createuser"},"application/xml":{"schemaId":"components/schemas/createuser"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/invitecodecoupon"}],"panels":[]}]},"httpPath":"/Invitecodecoupon/{{siteId}}?access_token={{access_token}}"},{"label":"Retrive the sharer email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/getshareremail","routeSlug":"/raf/raf/user/getshareremail","metadata":{"seo":{"title":"Retrive the sharer email address","description":"This API is used to get member information registered in the RAF module by providing an email address and incentive ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSharerEmail","name":"Retrive the sharer email address","isWebhook":false,"pointer":"/paths/~1userinformation~1{{siteId}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrive the sharer email address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API is used to get member information registered in the RAF module by providing an email address and incentive ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_306"}},"schemaId":"schema_306","pointer":"/paths/~1userinformation~1{{siteId}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/userinformation/{{siteId}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_306"}},"responseCodes":["200"],"pointer":"/userinformation/{{siteId}}?access_token={{access_token}}","href":"user/getshareremail","openApiOperationId":"getSharerEmail","summary":"Retrive the sharer email address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_306","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_306"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getSharerEmail"},"application/xml":{"schemaId":"components/schemas/getSharerEmail"}},"schemaId":"components/schemas/getSharerEmail"}],"pointer":"/paths/~1userinformation~1{{siteId}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/getSharerEmail","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/getSharerEmail"},"application/xml":{"schemaId":"components/schemas/getSharerEmail"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/getshareremail"}],"panels":[]}]},"httpPath":"/userinformation/{{siteId}}?access_token={{access_token}}"},{"label":"Get referrer's details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/user/invitecodedetail","routeSlug":"/raf/raf/user/invitecodedetail","metadata":{"seo":{"title":"Get referrer's details","description":"This API is used to get the referrer’s details through the stat ID and invite code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invitecodedetail","name":"Get referrer's details","isWebhook":false,"pointer":"/paths/~1userinvitecodedetail~1{{siteId}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get referrer's details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is used to get the referrer’s details through the stat ID and invite code."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"schemaId":"schema_307","pointer":"/paths/~1userinvitecodedetail~1{{siteId}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/userinvitecodedetail/{{siteId}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_307"}},"responseCodes":["200"],"pointer":"/userinvitecodedetail/{{siteId}}?access_token={{access_token}}","href":"user/invitecodedetail","openApiOperationId":"invitecodedetail","summary":"Get referrer's details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invitecodedetailresp"},"application/xml":{"schemaId":"components/schemas/invitecodedetailresp"}},"schemaId":"components/schemas/invitecodedetailresp"}],"pointer":"/paths/~1userinvitecodedetail~1{{siteId}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/invitecodedetailresp","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/invitecodedetailresp"},"application/xml":{"schemaId":"components/schemas/invitecodedetailresp"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/invitecodedetail"}],"panels":[]}]},"httpPath":"/userinvitecodedetail/{{siteId}}?access_token={{access_token}}"}],"content":{"contentType":"group","meta":{"name":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true},{"nodeType":"markdoc","content":"Thank you for choosing our Refer a Friend API to enhance your application's referral capabilities. This comprehensive documentation is designed to guide you through the seamless integration of our powerful referral system into your platform, allowing your users to effortlessly refer friends and unlock a world of rewards. Our team is committed to providing excellent developer support, so if you encounter any challenges or have any questions, please don't hesitate to reach out to us. We want to ensure that your experience with the Refer a Friend API is seamless and successful. So, let's get started and unlock the full potential of referral marketing together. A detailed explanation of the Refer a Friend User API and the examples are shown below."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/createuser/{{siteId}}?access_token={{access_token}}","summary":"Create a new user account under a specific site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/invitecodecoupon","deprecated":false},{"title":"/Referralstatus/{{siteId}}?access_token={{access_token}}","summary":"Get referral status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/invitecode","deprecated":false},{"title":"/Invitecodecoupon/{{siteId}}?access_token={{access_token}}","summary":"Create or Assign a new invite code coupon for a specific site","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/invitecodecoupon","deprecated":false},{"title":"/userinformation/{{siteId}}?access_token={{access_token}}","summary":"Retrive the sharer email address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/getshareremail","deprecated":false},{"title":"/userinvitecodedetail/{{siteId}}?access_token={{access_token}}","summary":"Get referrer's details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/invitecodedetail","deprecated":false}]}]}]}]}},{"type":"group","label":"Refer","link":"/raf/raf/refer","routeSlug":"/raf/raf/refer","items":[{"label":"Create bitly links","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/refer/createbitly","routeSlug":"/raf/raf/refer/createbitly","metadata":{"seo":{"title":"Create bitly links","description":"This API is used to create bitly links for specific member’s Facebook, Twitter, and Email Sharing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createbitly","name":"Create bitly links","isWebhook":false,"pointer":"/paths/~1Createbitly~1{{siteId}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create bitly links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is used to create bitly links for specific member’s Facebook, Twitter, and Email Sharing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_308"}},"schemaId":"schema_308","pointer":"/paths/~1Createbitly~1{{siteId}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/Createbitly/{{siteId}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_308"}},"responseCodes":["200"],"pointer":"/Createbitly/{{siteId}}?access_token={{access_token}}","href":"refer/createbitly","openApiOperationId":"createbitly","summary":"Create bitly links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_308","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_308"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createbitly"},"application/xml":{"schemaId":"components/schemas/createbitly"}},"schemaId":"components/schemas/createbitly"}],"pointer":"/paths/~1Createbitly~1{{siteId}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/createbitly","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createbitly"},"application/xml":{"schemaId":"components/schemas/createbitly"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refer/createbitly"}],"panels":[]}]},"httpPath":"/Createbitly/{{siteId}}?access_token={{access_token}}"},{"label":"Send e-mail to friends","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/refer/referralstatus","routeSlug":"/raf/raf/refer/referralstatus","metadata":{"seo":{"title":"Send e-mail to friends","description":"This API is used to trigger invitation emails to friends."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"referralStatus","name":"Send e-mail to friends","isWebhook":false,"pointer":"/paths/~1Sendemail~1{{siteId}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send e-mail to friends","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API is used to trigger invitation emails to friends."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309","pointer":"/paths/~1Sendemail~1{{siteId}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/Sendemail/{{siteId}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_309"}},"responseCodes":["200"],"pointer":"/Sendemail/{{siteId}}?access_token={{access_token}}","href":"refer/referralstatus","openApiOperationId":"referralStatus","summary":"Send e-mail to friends"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sendemailresp"},"application/xml":{"schemaId":"components/schemas/sendemailresp"}},"schemaId":"components/schemas/sendemailresp"}],"pointer":"/paths/~1Sendemail~1{{siteId}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/sendemailresp","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sendemailresp"},"application/xml":{"schemaId":"components/schemas/sendemailresp"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refer/referralstatus"}],"panels":[]}]},"httpPath":"/Sendemail/{{siteId}}?access_token={{access_token}}"}],"content":{"contentType":"group","meta":{"name":"Refer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refer","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Referral Marketing Program creates a channel for your customers to share your brand with their friends and family. From social media integration to email, and in-person recommendations you can proactively cultivate referrals anywhere, and comprehensive reporting helps you track and optimize your various referral channels. Most of the consumers trust recommendations from friends and family more than other forms of advertising. Refer a Friend enables you to organically grow your customer base by giving your loyal shoppers a platform to advocate for your brand. This API is used to send email invitations to members' friends and to get bitly against the specific social type (i.e., Facebook, Twitter & SMS sharing). A detailed explanation of RAF Refer API and the examples are shown below."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/Createbitly/{{siteId}}?access_token={{access_token}}","summary":"Create bitly links","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refer/createbitly","deprecated":false},{"title":"/Sendemail/{{siteId}}?access_token={{access_token}}","summary":"Send e-mail to friends","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refer/referralstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Reward","link":"/raf/raf/reward","routeSlug":"/raf/raf/reward","items":[{"label":"Generate a coupon code for an invitee using a referral invite code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/raf/raf/reward/invitecouponsiteidaccesstoken","routeSlug":"/raf/raf/reward/invitecouponsiteidaccesstoken","metadata":{"seo":{"title":"Generate a coupon code for an invitee using a referral invite code","description":"This endpoint is used to generate and assign a coupon code to a referred user (invitee) based on a valid referral invite code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"invitecouponsiteidaccesstoken","name":"Generate a coupon code for an invitee using a referral invite code","isWebhook":false,"pointer":"/paths/~1Invitecodecoupon~1{{site_id}}?access_token={{access_token}}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a coupon code for an invitee using a referral invite code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used to generate and assign a coupon code to a referred user (invitee) based on a valid referral invite code."},{"nodeType":"security","requirements":[{"schemes":[{"name":"MuseumPlaceholderAuth","scopes":[]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"schemaId":"schema_310","pointer":"/paths/~1Invitecodecoupon~1{{site_id}}?access_token={{access_token}}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/Invitecodecoupon/{{site_id}}?access_token={{access_token}}","servers":[{"url":"https://s2.socialannex.net/api/"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_310"}},"responseCodes":["200"],"pointer":"/Invitecodecoupon/{{site_id}}?access_token={{access_token}}","href":"reward/invitecouponsiteidaccesstoken","openApiOperationId":"invitecouponsiteidaccesstoken","summary":"Generate a coupon code for an invitee using a referral invite code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://s2.socialannex.net/api/"}],"schemaId":"schema_310","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createuser"},"application/xml":{"schemaId":"components/schemas/createuser"}},"schemaId":"components/schemas/createuser"}],"pointer":"/paths/~1Invitecodecoupon~1{{site_id}}?access_token={{access_token}}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/createuser","mediaTypes":["application/json","application/xml"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/createuser"},"application/xml":{"schemaId":"components/schemas/createuser"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reward/invitecouponsiteidaccesstoken"}],"panels":[]}]},"httpPath":"/Invitecodecoupon/{{site_id}}?access_token={{access_token}}"}],"content":{"contentType":"group","meta":{"name":"Reward"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reward","showPageActions":true},{"nodeType":"markdoc","content":"Referral Marketing Program creates a channel for your customers to share your brand with their friends and family. From social media integration to email, and in-person recommendations you can proactively cultivate referrals anywhere, and comprehensive reporting helps you track and optimize your various referral channels. Customers who share your brand with their friends and family can earn good rewards. These rewards are in terms of various coupon codes and gift vouchers. This API is used to provide coupon codes, claim and manage earned rewards. A detailed explanation of RAF Reward API and the examples are shown below."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/Invitecodecoupon/{{site_id}}?access_token={{access_token}}","summary":"Generate a coupon code for an invitee using a referral invite code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reward/invitecouponsiteidaccesstoken","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/createuser":{"id":"components/schemas/createuser","kind":"json-schema","title":"createuser","data":{"type":"object","properties":{"status":{"type":"string","description":"Displays the status of the API executed. If Success is shown then the API has executed successfully. If Failed is shown, then the API has failed to execute.","example":"Success"},"data":{"type":"object","description":"Displays the following details.","properties":{"coupon_code":{"type":"string","description":"Displays the coupon code.","example":"RKTKR"},"message":{"type":"string","description":"Displays the Success or failure message.","example":"Coupon Code Generated successfully"}}}}}},"components/schemas/createbitly":{"id":"components/schemas/createbitly","kind":"json-schema","title":"createbitly","data":{"type":"object","properties":{"status":{"type":"string","description":"Displays the status of the API executed. If Success is shown then the API has executed successfully. If Failed is shown, then the API has failed to execute.","example":"Success"},"data":{"type":"object","properties":{"bitly":{"type":"integer","description":"Displays the bitly link for the social type.","example":"https://bit.ly/3Bdfgfc"}}}}}},"components/schemas/invitecouponsiteidaccesstokenresp":{"id":"components/schemas/invitecouponsiteidaccesstokenresp","kind":"json-schema","title":"invitecouponsiteidaccesstokenresp","data":{"type":"object","properties":{"status":{"type":"string","description":"Displays the status of the API executed. If Success is shown then the API has executed successfully. If Failed is shown, then the API has failed to execute.","example":"Success"},"data":{"type":"object","description":"Displays the following details.","properties":{"coupon_code":{"type":"string","description":"Displays the coupon code.","example":"RKTKR"},"message":{"type":"string","description":"Displays the Success or failure message.","example":"Coupon Code Generated successfully"}}}}}},"components/schemas/userDetails":{"id":"components/schemas/userDetails","kind":"json-schema","title":"userDetails","data":{"type":"object","properties":{"status":{"type":"string","description":"Displays the status of the API executed. If Success is shown then the API has executed successfully. If Failed is shown, then the API has failed to execute.","example":"Success"},"data":{"type":"object","properties":{"sharedata":{"type":"object","description":"Displays the data regarding how the referral was shared","properties":{"referral_settings":{"type":"object","description":"Displays the data regarding the referral settings","properties":{"refferal_status_col_email_address":{"type":"string","description":"Displays the reference field name, when the referral status API gets the data, the email address field is shown in the response.","example":"Email Address"},"refferal_status_col_email_network":{"type":"string","description":"Displays the reference field name, when the referral status API gets the data, the social type field is shown in the response.","example":"Network"},"refferal_status_col_status":{"type":"string","description":"Displays the reference field name, when the referral status API gets the data, the status field is shown in the response.","example":"Status"}}},"referral_status":{"type":"object","description":"Displays the data regarding the referral status","properties":{"email_address":{"type":"string","description":"Displays the email address of the referee.","example":"harrywhite21.sa@gmail.com"},"friend_fullname":{"type":"string","description":"Displays the full name of the referee.","example":"harry.sa"},"add_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the date and time when the referee became registered as a member. The format of the date and time is “yyyy-MM-dd'T'HH:mm:ss Z”."},"children":[]}]}]}],"example":"2022-08-01 07:31:32"},"update_status_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the date and time when the referee’s status was updated. The format of the date and time is “yyyy-MM-dd'T'HH:mm:ss Z”."},"children":[]}]}]}],"example":"2022-08-01 07:31:32"},"status":{"type":"string","description":"Displays the status of the referee as-Invite sent, Waiting for purchase, or Purchased.","example":"Invite sent"},"social_type":{"type":"string","description":"Displays in which social type the sharer has referred the referee. For example- Twitter, Facebook, or copy link.","example":"Copy link"},"network_img":{"type":"string","description":"Displays the link for the logo of the social network in which the sharer has referred the referee.","example":"https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png"},"stat_id":{"type":"integer","description":"Displays the statistical tracking ID generated when a member shares via Facebook, Email, X, Personal link, and Referral code. This ID is linked to the referral code and is used for all RAF sharing actions (Facebook, Email, X, Personal link, and Referral code).","example":11181},"referral_purchase_count":{"type":"integer","description":"Displays the number of referral purchases if the referee has made purchases with the brand.","example":10}}}}}}}}}},"components/schemas/sendemailresp":{"id":"components/schemas/sendemailresp","kind":"json-schema","title":"sendemailresp","data":{"type":"object","properties":{"status":{"type":"string","description":"Displays the status of the API executed. If Success is shown then the API has executed successfully. If Failed is shown, then the API has failed to execute.","example":"Success"},"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the data for email invitations sent to the email address mentioned in the request parameter “toemail” with the success message."},"children":[]}]}]}]}}}},"components/schemas/getSharerEmail":{"id":"components/schemas/getSharerEmail","kind":"json-schema","title":"getSharerEmail","data":{"type":"object","properties":{"status":{"type":"string","description":"Displays the status of the API executed. If Success is shown then the API has executed successfully. If Failed is shown, then the API has failed to execute.","example":"Success"},"data":{"type":"object","properties":{"userinfo":{"type":"object","properties":{"user_id":{"type":"string","description":"Displays the unique identifier for the member. It is a unique numerical code assigned to each member. The user ID is created in the RAF module for the member.","example":"12345"},"email_id":{"type":"string","description":"Displays the email address of a member. Email addresses are often used as unique identifiers for member accounts.","example":"user@domain.com"},"first_name":{"type":"string","description":"Displays the first name of the referred member.","example":"john"},"last_name":{"type":"string","description":"Displays the last name of the referred member.","example":"dee"},"from_email":{"type":"string","description":"Displays the referrer member email address.","example":"dean@yahoo.com"},"sharer_stat_id":{"type":"integer","description":"Displays the sharer static identifier of the member who shared the invite code to the friend.","example":1234},"default_personal_bitly":{"type":"string","description":"Displays the members' personal data with bitly link.","example":"https://bit.ly/3Bdfgfc"},"personal_invite_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays sharer’s personal invite code. The invite code is provided to members to refer a friend."},"children":[]}]}]}],"example":"f7BUBJ"},"db_update_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the date when the member's information was last updated in the database. The format of the date is “YYYY-MM-DD“."},"children":[]}]}]}],"example":"2023-12-06"},"referer_id":{"type":"integer","description":"Displays the unique identifier of the referer who referred the friend by the the invite code or bitly link.","example":10203057}}}}},"account_info":{"type":"object","properties":{"db_add_data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the date when the member's information was added to the database (member registered date). The format of the date is “yyyy-MM-dd'T'HH:mm:ss Z”."},"children":[]}]}]}],"example":"2021-02-09T18:27:35+0000"},"db_update_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the date when the member's information was updated in the database. The format of the date is “yyyy-MM-dd“."},"children":[]}]}]}],"example":"2021-02-09"},"user_id":{"type":"string","description":"Displays the unique identifier for the member. It is a unique numerical code assigned to each member. The user ID is created in the RAF module for the member.","example":"1234"},"login__log":{"type":"integer","description":"Displays the number of times the member has logged in to their account.","example":10}}},"activity_info":{"type":"object","properties":{"total_orders":{"type":"integer","description":"Displays total number of orders placed by the member.","example":20},"revenue":{"type":"integer","description":"Displays the total amount spent by the member.","example":1205}}},"order_details":{"type":"object","properties":{"order_id":{"type":"integer","description":"Displays the order ID for the order placed by the member.","example":123456},"create_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the date and time of the order placed by the member. The format of the date and time is “yyyy-MM-dd'T'HH:mm:ss Z”."},"children":[]}]}]}],"example":"2021-02-09T18:27:35+0000"},"order_amount":{"type":"integer","description":"Displays the price of the order placed by the member.","example":56}}},"referral_program":{"type":"object","properties":{"sharing_details":{"type":"object","properties":{"facebook":{"type":"integer","description":"Displays the number of times the personal URL has been shared via Facebook.","example":12},"twitter":{"type":"integer","description":"Displays the number of times the personal URL has been shared via Twitter.","example":23},"email":{"type":"integer","description":"Displays the number of times the personal URL has been shared via email.","example":34},"personal_bitly":{"type":"integer","description":"Displays the number of times the referral bitly link has been shared.","example":45},"other":{"type":"integer","description":"Displays the number of times RAF invite code has been shared by the member.","example":56}}}}},"coupon_details":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays the member’s coupon codes details with status. If the member registers with the invite code sent by the referer, the member will get a coupon code."},"children":[]}]}]}]},"reward_details":{"type":"array","description":"Displays reward details of a member who shared the invite code. The member has credit points to claim reward codes. the list of rewards claimed is displayed."}}}},"components/schemas/invitecodedetailresp":{"id":"components/schemas/invitecodedetailresp","kind":"json-schema","title":"invitecodedetailresp","data":{"type":"object","properties":{"status":{"type":"string","description":"Displays the status of the API executed. If Success is shown then the API has executed successfully. If Failed is shown, then the API has failed to execute.","example":"Success"},"data":{"type":"object","properties":{"user_email":{"type":"string","description":"Displays the email address of the member who referred their friend.","example":"jacklee2023.sa1708222@gmail.com"},"user_id":{"type":"string","description":"Displays the unique identifier for the member. It is a unique numerical code assigned to each member. The user ID is created in the RAF module for the member.","example":"1234"},"messages":{"type":"string","description":"Displays the message Get user info successfully, if member information is successfully fetched.","example":"Get user info successfully"}}}}}},"schema_304":{"kind":"json-schema","data":{"type":"object","properties":{"site_Id":{"description":"Enter an identifier for the specific site. It is a unique numerical code assigned to each site provided by Annex Cloud.","example":"123456","type":"string"},"access_token":{"description":"Enter the access token provided by Annex Cloud.","type":"string","example":"vsdhsvdj5555dd"},"invite_code":{"description":"Enter the code used for inviting members to join the platform.","type":"string","example":"cfd55ss"},"sa_stat_id":{"description":"Enter the statistical tracking ID of the member who is referring a friend. This ID is provided by Annex Cloud. This ID is created when the member shares the referral code with a friend. This ID is linked to the referral code.","example":54465,"type":"integer"},"friendEmail":{"description":"Enter the email address of the referree.","type":"string","example":"user@gmail.com"},"incentive_id":{"description":"Enter an identifier for the specific  Refer a Friend campaign incentive. It is used to track and manage incentives. Annex Cloud will provide Incentive ID.","example":"55599","type":"string"}},"required":["site_Id","access_token","invite_code","friendEmail","incentive_id"]},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"object","properties":{"site_Id":{"description":"Enter an identifier of the specific site. It is a unique numerical code assigned to each site provided by Annex Cloud.","example":"123456","type":"string"},"access_token":{"description":"Enter the access token provided by Annex Cloud.","type":"string","example":"hgt45dg"},"user_id":{"description":"Enter the unique identifier of the member.","type":"string","example":"1234"},"incentive_id":{"description":"Enter an identifier for the specific incentive provided by the Annex Cloud. It is used to track and manage incentives.","example":34567,"type":"integer"}},"required":["site_Id","access_token","user_id","incentive_id"]},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"object","properties":{"site_Id":{"description":"Enter an identifier for the specific site. It is a unique numerical code assigned to each site provided by Annex Cloud.","example":"123456","type":"string"},"access_token":{"description":"Enter the access token provided by Annex Cloud.","type":"string","example":"vsdhsvdj5555dd"},"email":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the email address of the member. Email addresses are often used as unique identifiers for member accounts. If a unique ID number is used to identify members for your program, then the unique ID number is entered in this field and the email is entered in the user_email field."},"children":[]}]}]}],"example":"user@gmail.com","type":"string"},"incentive_id":{"description":"Enter an identifier for the specific  Refer a Friend campaign incentive. It is used to track and manage incentives. Annex Cloud will provide Incentive ID.","example":55599,"type":"integer"}},"required":["site_Id","access_token","email","incentive_id"]},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"object","properties":{"stat_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the referrer’s static identifier of the member who shared the invite code to the friend."},"children":[]}]}]}],"example":1234,"type":"integer"},"invite_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the referrer’s personal invite code. The invite code is provided to members to refer a friend."},"children":[]}]}]}],"example":"1234","type":"string"},"access_token":{"description":"Enter the access token provided by Annex Cloud.","type":"string","example":"hgt45dg"}},"required":["access_token"]},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"object","properties":{"site_Id":{"description":"Enter the unique identifier for the specific site. It is a unique numerical code assigned to each site provided by Annex Cloud.","example":"123456","type":"string"},"access_token":{"description":"Enter the access token provided by Annex Cloud.","type":"string","example":"hgt45dg"},"user_id":{"description":"Enter the unique identifier for the member.","type":"string","example":"1234"},"incentive_id":{"description":"Enter an identifier for the specific incentive provided by the Annex Cloud. It is used to track and manage incentives.","example":456,"type":"integer"},"socialType":{"description":"Enter the value 1 for Facebook Bitly, 2 for Twitter Bitly, 4 for Email Bitly.","type":"integer","example":1}},"required":["site_Id","access_token","user_id","incentive_id","socialType"]},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"object","properties":{"site_Id":{"description":"Enter an identifier of the specific site. It is a unique numerical code assigned to each site provided by Annex Cloud.","example":"123456","type":"string"},"access_token":{"description":"Enter the access token provided by Annex Cloud.","type":"string","example":"hgt45dg"},"user_id":{"description":"Enter the unique identifier of the member.","type":"string","example":"1234"},"toemail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the email addresses of friends who should receive the email invitation. You can add  upto 10 email addresses separated by “,”."},"children":[]}]}]}],"type":"string","example":"user@domain.com, user1@domain1.com,user2@dmoin2.com,user3@domain3.com"},"incentive_id":{"description":"Enter an identifier for the specific incentive provided by the Annex Cloud. It is used to track and manage incentives.","type":"integer","example":456}},"required":["site_Id","access_token","user_id","toEmail","incentive_id"]},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"object","properties":{"site_id":{"description":"Enter an identifier for the specific site. It is the unique numerical code assigned to each site provided by Annex Cloud.","example":"1234","type":"string"},"access_token":{"description":"Enter the access token provided by Annex Cloud.","type":"string","example":"hgt45dg"},"invite_code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the referrer’s personal invite code. The invite code is provided to members to refer a friend."},"children":[]}]}]}],"example":"1234","type":"string"},"sa_stat_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the referrer’s static identifier of the member who shared the invite code to the friend."},"children":[]}]}]}],"type":"integer","example":1234},"friend_email":{"description":"Enter the email address of the referred friend to associate them with the referral process.","example":"xyz@gmail.com","type":"string"},"incentive_id":{"description":"Enter an identifier for the specific incentive provided by the Annex Cloud. It is used to track and manage incentives.","example":"hgt45dg","type":"string"}},"required":["site_id","access_token","invite_code","friend_email","incentive_id"]},"id":"schema_310"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://s2.socialannex.net/api/"}]},"options":{"hideReplay":true,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/raf/raf.json?download"},{"url":"/_bundle/raf/raf.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Refer a Friend V3 APIs","description":"Thank you for choosing our Refer a Friend API to enhance your application's referral capabilities. This comprehensive documentation is designed to guide you through the seamless integration of our powerful referral system into your platform, allowing your users to effortlessly refer friends and unlock a world of rewards. Our team is committed to providing excellent developer support, so if you encounter any challenges or have any questions, please don't hesitate to reach out to us. We want to ensure that your experience with the Refer a Friend API is seamless and successful. So, let's get started and unlock the full potential of referral marketing together. A detailed explanation of the Refer a Friend User API and the examples are shown below."}},"baseSlug":"/raf/raf","routesMapping":{}}