Redeem referral code

POST

/api/v1/revenue/referral/redeem

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/revenue/referral/redeem \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "code": "example", "email": "example" }'

• Production
• Local development

Redeem a referral code for a new user.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

RedeemRequest

Request body for referral code redemption.

Attributes: code: The referral code to redeem. email: Email of the new user being referred.

object

code

required

Code

Referral code

string

>= 1 characters

email

required

Email

Referee email

string

>= 1 characters

Example^generated

{
  "code": "example",
  "email": "example"
}

Responses

201

Successful Response

Media typeapplication/json

Response Redeem Referral Api V1 Revenue Referral Redeem Post

object

key

additional properties

any

Example^generated

{}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}