Referrals

Storefront REST API endpoints related to Okendo Referrals

Create Referral Sender

post

Path parameters

subscriberIdstringRequired

The unique identifier for the store. Available on the Okendo integration settings page.

Header parameters

okendo-api-versionstring · enumRequired

API version header

Possible values:

okendo-partner-idstringOptional

Body

application/json

emailstring · emailRequired

Responses

200

Successfully created referral sender

application/json

referralSenderIdstring · uuidRequired

The Referral Sender ID is required for sending referral requests via authenticated endpoints

shareableLinkUrlstring · uriRequired

A URL which can be sent as a referral link

400

Bad Request - Invalid email address

application/json

post

/stores/{subscriberId}/referral_senders

HTTPcURLJavaScriptPython

POST /v1/stores/{subscriberId}/referral_senders HTTP/1.1
Host: api.okendo.io
okendo-api-version: 2025-02-01
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

{
  "referralSenderId": "123e4567-e89b-12d3-a456-426614174000",
  "shareableLinkUrl": "https://example.com"
}