API Reference

Retrieve List of All Referral Codes

post https://api.vault.sandbox.testessential.net/v1/referral

This endpoint is designed for adding a referral code to a customer profile and retrieving details about the referral code.

Referral Code Validation Rules

When adding a referral code to a customer profile, the following validation rules must be enforced:

1. Length

  • The code must be 20 characters long.

2. Allowed Characters

The code may contain:

  • Latin letters (A-Z, a-z)
  • Numbers (0-9)
  • Hyphens (-)
  • En dashes (—)
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!