Apply Referral

POST

/v1/referral/apply

curl --request POST \
  --url https://api.cloud.agentums.ru/v1/referral/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example" }'

• Прод

Применить код реферера: один раз, не свой и только ДО первой оплаты. → зачтён ли реферал.

До первой оплаты — любой, включая вход за 1 ₽ и пополнение. Без этого платящий клиент мог присоединиться к знакомому когда угодно и отдать ему процент со своей следующей оплаты — то есть с продления, а награда положена только за первую оплату тарифа (решение владельца 01.10.2026). Отказ здесь — 409 с текстом: «код не подошёл» было бы неправдой, код-то верный.

Остальные отказы — чужой код не найден, свой код, уже приглашён — по-прежнему applied: false: клиенты уже читают их так, и ломать им ответ незачем.

Проверка оплаты — дважды: до кода и вплотную к коммиту. Между первой проверкой и записью приглашения может пройти первая оплата; её начисление строки ещё не видит, и приглашение повисло бы после неё — процент достался бы следующей оплате, а не первой. Второй взгляд сужает это окно до мгновения между ним и коммитом.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

ReferralApply

object

code

required

Code

string

>= 1 characters <= 16 characters

Example^generated

{
  "code": "example"
}

Responses

200

Successful Response

Media typeapplication/json

ReferralApplyOut

object

applied

required

Applied

boolean

Example^generated

{
  "applied": true
}

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"
    }
  ]
}