Skip to main content
PATCH
Atualiza um link (o token é imutável)

Authorizations

Authorization
string
header
required

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

Path Parameters

Identificador do link (prefixo link_).

Pattern: ^link_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"link_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

Body

application/json
subId
string | null

Novo identificador de subcampanha/origem. Envie null para limpar. O token do link é imutável e não pode ser alterado aqui.

Required string length: 1 - 120
Example:

"youtube-descricao"

destinationUrl
string<uri> | null

Nova URL de destino do redirecionamento. Deve pertencer a um domínio na whitelist da organização. Envie null para voltar ao destino padrão do programa.

Example:

"https://loja.exemplo.com/oferta"

Response

200 - application/json

Default Response

id
string
required

Identificador único do link (prefixo link_).

Example:

"link_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

organizationId
string
required

Identificador da organização dona do link.

Example:

"org_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

programId
string
required

Identificador do programa ao qual o link pertence.

Example:

"prog_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

affiliateId
string
required

Identificador do afiliado dono do link.

Example:

"aff_01J9Z3K7Qn8vYwT2bX4cE6dF8g"

token
string
required

Token público do link (em minúsculas), único globalmente.

Example:

"maria-silva"

subId
string | null
required

Identificador de subcampanha/origem, ou null se não definido.

Example:

"instagram-bio"

destinationUrl
string | null
required

URL de destino do redirecionamento, ou null quando usa o destino padrão do programa.

Example:

"https://loja.exemplo.com/produto"

isDefault
boolean
required

Indica se este é o link padrão do afiliado (gerado automaticamente).

status
enum<string>
required

Situação do link. active: aceita cliques e redireciona. inactive: desativado, não redireciona (token segue reservado por 12 meses).

Available options:
active,
inactive
Example:

"active"

deactivatedAt
string<date-time> | null
required

Data/hora (ISO-8601) em que o link foi desativado, ou null se ativo.

Example:

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

createdAt
string<date-time>
required

Data/hora (ISO-8601) de criação do link.

Example:

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

updatedAt
string<date-time>
required

Data/hora (ISO-8601) da última atualização do link.

Example:

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

url
string | null

URL pública e clicável do link ({domínio}/t/{token}), já no domínio próprio/primário da organização quando configurado. null/ausente quando a API não tem um domínio base — o cliente usa o fallback local.

Example:

"https://go.userepass.com/t/maria-silva"