Skip to main content
POST
Cria um job de reprocessamento (sempre uma simulação com o relatório de impacto)

Authorizations

Authorization
string
header
required

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

Body

application/json
programId
string
required

Programa cujas comissões serão reprocessadas.

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

"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"

from
any
required

Início da janela de reprocessamento (ISO-8601). Apenas conversões/comissões a partir desta data são consideradas.

Example:

"2026-05-01T00:00:00.000Z"

to
any
required

Fim da janela de reprocessamento (ISO-8601). Apenas conversões/comissões até esta data são consideradas.

Example:

"2026-05-31T23:59:59.000Z"

newRuleId
string
required

Regra de comissão a ser aplicada no recálculo (substitui a regra usada originalmente).

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

"cmrl_01J9Z3K8N2QF4T7B9XP0WMD5RC"

affiliateIds
string[]

Restringe o reprocessamento a estes afiliados. Omitido: reprocessa todos os afiliados do programa na janela.

Minimum array length: 1
Pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$
dryRun
enum<boolean>
default:true

Sempre true: a criação é obrigatoriamente uma simulação. A aplicação definitiva ocorre apenas no passo de execução do job (POST /reprocess/:jobId/execute).

Available options:
true

Response

201 - application/json

Default Response

id
string
required

Identificador único do job de reprocessamento (prefixo repr_ + ULID).

Example:

"repr_01J9Z3K8N2QF4T7B9XP0WMD5RC"

organizationId
string
required

Organização dona do job.

Example:

"org_01J9Z3K8N2QF4T7B9XP0WMD5RC"

programId
string
required

Programa cujas comissões foram reprocessadas.

Example:

"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"

status
enum<string>
required

Status atual do job.

Available options:
dry_run,
executed,
canceled
Example:

"dry_run"

newRuleId
string
required

Regra de comissão aplicada no recálculo.

Example:

"cmrl_01J9Z3K8N2QF4T7B9XP0WMD5RC"

from
string<date-time>
required

Início da janela de reprocessamento (ISO-8601).

Example:

"2026-05-01T00:00:00.000Z"

to
string<date-time>
required

Fim da janela de reprocessamento (ISO-8601).

Example:

"2026-05-31T23:59:59.000Z"

affiliateIds
string[] | null
required

Afiliados aos quais o reprocessamento foi restrito. null quando abrange todos os afiliados do programa.

summary
object
required

Relatório de impacto do reprocessamento.

confirmationRequired
boolean
required

Indica se a execução exigirá confirmationToken por ultrapassar o limite de impacto configurado nas suas preferências de reprocessamento.

Example:

true

createdBy
string
required

Usuário que criou o job.

Example:

"user_01J9Z3K8N2QF4T7B9XP0WMD5RC"

executedAt
string<date-time> | null
required

Momento em que o job foi executado (ISO-8601). null enquanto não executado.

Example:

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

canceledAt
string<date-time> | null
required

Momento em que o job foi cancelado (ISO-8601). null quando não cancelado.

Example:

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

createdAt
string<date-time>
required

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

Example:

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

updatedAt
string<date-time>
required

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

Example:

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

confirmationToken
string

Token da dupla confirmação. Presente apenas enquanto o job está em dry_run; usado na execução do job quando o impacto excede o limite configurado nas suas preferências de reprocessamento.

Example:

"rcft_01J9Z3K8N2QF4T7B9XP0WMD5RC"