Skip to main content
POST
Publica uma nova versão dos termos (markdown ou link externo)

Authorizations

Authorization
string
header
required

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

Path Parameters

programId
string
required

Identificador do programa cujos termos serão listados/publicados.

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

"prog_01J9Z8M3QK8X2YV4N7P5R6T0EF"

Body

application/json
format
enum<string>
default:markdown

Formato dos termos publicados por JSON. markdown exige content; link exige url. PDF é enviado por multipart.

Available options:
markdown,
link
content
string

Conteúdo integral dos termos em Markdown. Obrigatório quando format é markdown.

Minimum string length: 1
Example:

"# Termos do Programa de Afiliados\n\nAo participar, você concorda com as regras de comissão e pagamento descritas abaixo..."

url
string<uri>

URL externa dos termos (será exibida via iframe). Obrigatória quando format é link.

Example:

"https://exemplo.com/termos-do-programa"

requireReacceptance
boolean
default:false

Se true, afiliados que já haviam aceitado uma versão anterior precisam reaceitar esta nova versão antes de continuar operando.

Response

201 - application/json

Default Response

id
string
required

Identificador único da versão dos termos.

Example:

"term_01J9Z8M3QK8X2YV4N7P5R6T0AB"

organizationId
string
required

Identificador da organização dona dos termos.

Example:

"org_01J9Z8M3QK8X2YV4N7P5R6T0CD"

programId
string
required

Identificador do programa ao qual esta versão de termos pertence.

Example:

"prog_01J9Z8M3QK8X2YV4N7P5R6T0EF"

version
integer
required

Número sequencial da versão dos termos no programa (incrementa a cada publicação).

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

3

format
enum<string>
required

Formato dos termos: markdown (texto), pdf (arquivo) ou link (URL externa exibida via iframe).

Available options:
markdown,
pdf,
link
content
string | null
required

Conteúdo integral dos termos em Markdown (presente apenas quando format é markdown).

externalUrl
string | null
required

URL externa dos termos (presente apenas quando format é link).

fileName
string | null
required

Nome original do arquivo PDF (presente apenas quando format é pdf). O download é feito via GET /programs/:programId/terms/:version/file.

requireReacceptance
boolean
required

Indica se esta versão exige que afiliados que aceitaram versões anteriores reaceitem os termos.

createdAt
string<date-time>
required

Data/hora de publicação desta versão (ISO-8601).

Example:

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