Skip to main content
POST
Altera o tier do afiliado

Authorizations

Authorization
string
header
required

Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....

Path Parameters

affiliateId
string
required
Pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
tier
string | null
required

Novo tier do afiliado. null retorna o afiliado ao tier base do programa.

Minimum string length: 1
Example:

"gold"

Response

200 - application/json

Default Response

id
string
required

Identificador único do afiliado (prefixo aff_ + ULID).

Example:

"aff_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId
string
required

Organização dona do afiliado.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

programId
string
required

Programa ao qual o afiliado pertence.

Example:

"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"

affiliateUserId
string | null
required

ID do usuário vinculado ao afiliado (preenchido após aceite do convite). null quando ainda não vinculado.

Example:

"user_01J9Z3K8N2QF4T7B9XP0WMD5RC"

name
string
required

Nome do afiliado.

Example:

"Maria Silva"

email
string
required

E-mail do afiliado. Único por programa.

status
enum<string>
required

Status atual do afiliado.

Available options:
pending,
approved,
rejected,
paused,
banned
Example:

"approved"

tier
string | null
required

Tier atual do afiliado. null quando usa o tier base do programa.

Example:

"gold"

customCommissionRuleId
string | null
required

Regra de comissão customizada que sobrepõe a regra do tier. null quando não há customização.

Example:

"comm_01J9Z3K8N2QF4T7B9XP0WMD5RC"

acceptedTermsVersion
integer | null
required

Versão dos termos do programa aceita pelo afiliado. null quando ainda não aceitou.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

3

payoutMethod
enum<string>
required

Método de pagamento usado nos payouts. Atualmente apenas pix (PIX).

Available options:
pix
Example:

"pix"

pixKey
string | null
required

Chave PIX do afiliado. null quando não configurada.

pixKeyType
enum<string> | null
required

Tipo da chave PIX (cpf, cnpj, email, phone ou random). null quando não configurada.

Available options:
cpf,
cnpj,
email,
phone,
random
Example:

"email"

cnpj
string | null
required

CNPJ do afiliado normalizado a 14 dígitos. null quando não informado.

Example:

"11222333000181"

importedTotalEarnedCents
integer | null
required

Total histórico ganho em centavos ao importar de outra plataforma (ex.: 1990 = R$19,90). null quando não importado.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1990

importedSince
string<date-time> | null
required

Data de início do relacionamento ao importar de outra plataforma (ISO-8601). null quando não importado.

Example:

"2026-06-13T12:00:00.000Z"

createdAt
string<date-time>
required

Data de criação do afiliado (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"

updatedAt
string<date-time>
required

Data da última atualização do afiliado (ISO-8601).

Example:

"2026-06-13T12:00:00.000Z"