Arquiva um programa

POST

programs

{programId}

archive

Arquiva um programa

curl --request POST \
  --url https://api.userepass.com/programs/{programId}/archive \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/programs/{programId}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userepass.com/programs/{programId}/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userepass.com/programs/{programId}/archive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/programs/{programId}/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "prog_01J9ZK8QF3N2P5R7T9V1W3X5Y7",
  "organizationId": "org_01J9ZK8QF3N2P5R7T9V1W3X5Y7",
  "name": "Programa de Indicação Premium",
  "currency": "BRL",
  "status": "active",
  "approvalMode": "manual",
  "publicSignupEnabled": false,
  "publicSlug": "programa-indique-e-ganhe-a1b2",
  "attributionModel": "last_click",
  "attributionWindowDays": 30,
  "holdDays": 30,
  "landingUrl": "https://exemplo.com/promo",
  "approvalDomainWhitelist": [
    "exemplo.com"
  ],
  "maxLinksPerAffiliate": 50,
  "couponAttributionPolicy": "coupon_wins",
  "commissionBasis": "gross",
  "createdAt": "2026-06-13T12:00:00.000Z",
  "updatedAt": "2026-06-13T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

programId

string

required

Identificador do programa (prefixo prog_ + ULID).

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

Example:

"prog_01J9ZK8QF3N2P5R7T9V1W3X5Y7"

Response

200 - application/json

Default Response

string

required

Identificador único do programa (prefixo prog_ + ULID).

Example:

"prog_01J9ZK8QF3N2P5R7T9V1W3X5Y7"

organizationId

string

required

Identificador da organização dona do programa.

Example:

"org_01J9ZK8QF3N2P5R7T9V1W3X5Y7"

name

string

required

Nome do programa de afiliados.

Example:

"Programa de Indicação Premium"

currency

string

required

Moeda do programa (ISO 4217). Atualmente sempre BRL.

Example:

"BRL"

status

enum<string>

required

Status do programa: active (operando), paused (suspenso temporariamente) ou archived (encerrado permanentemente).

Available options:

active,

paused,

archived

Example:

"active"

approvalMode

enum<string>

required

Modo de aprovação de afiliados: automatic (aprovação imediata no cadastro), manual (operador revisa cada solicitação) ou domain_whitelist (aprova automaticamente apenas e-mails de domínios listados).

Available options:

automatic,

manual,

domain_whitelist

Example:

"manual"

Indica se o cadastro público de afiliados está habilitado.

Example:

false

publicSlug

string | null

required

Identificador legível da URL pública de inscrição (kebab(nome)-XXXX). Gerado automaticamente quando publicSignupEnabled é habilitado; null quando nunca foi habilitado. Estável — desabilitar não limpa, reabilitar reusa o mesmo slug. A URL de inscrição é <portal>/join/<publicSlug>.

Example:

"programa-indique-e-ganhe-a1b2"

attributionModel

enum<string>

required

Modelo de atribuição da conversão entre cliques: first_click (primeiro clique), last_click (último clique), linear (crédito igual entre todos), time_decay (mais peso aos cliques recentes) ou position_based (mais peso ao primeiro e ao último).

Available options:

first_click,

last_click,

linear,

time_decay,

position_based

Example:

"last_click"

attributionWindowDays

integer

required

Janela de atribuição em dias.

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

30

holdDays

integer

required

Período de carência em dias antes da comissão ficar disponível.

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

30

landingUrl

string | null

required

URL de destino padrão dos links do programa.

Example:

"https://exemplo.com/promo"

approvalDomainWhitelist

string[] | null

required

Domínios de e-mail aprovados automaticamente no modo domain_whitelist.

Example:

["exemplo.com"]

maxLinksPerAffiliate

integer

required

Quantidade máxima de links por afiliado.

Required range: -9007199254740991 <= x <= 9007199254740991

Example:

50

couponAttributionPolicy

enum<string>

required

Política de desempate quando a conversão tem cupom E clique atribuído: coupon_wins (cupom leva a comissão), click_wins (clique leva) ou split_50_50 (comissão dividida igualmente).

Available options:

coupon_wins,

click_wins,

split_50_50

Example:

"coupon_wins"

commissionBasis

enum<string>

required

Base de cálculo da comissão: gross (sobre o valor bruto da venda) ou net_of_gateway_fees (sobre o valor líquido, descontadas as taxas do gateway de pagamento).

Available options:

gross,

net_of_gateway_fees

Example:

"gross"

createdAt

string<date-time>

required

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

Example:

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

updatedAt

string<date-time>

required

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

Example:

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

Arquiva um programa

curl --request POST \
  --url https://api.userepass.com/programs/{programId}/archive \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userepass.com/programs/{programId}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userepass.com/programs/{programId}/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userepass.com/programs/{programId}/archive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.userepass.com/programs/{programId}/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "prog_01J9ZK8QF3N2P5R7T9V1W3X5Y7",
  "organizationId": "org_01J9ZK8QF3N2P5R7T9V1W3X5Y7",
  "name": "Programa de Indicação Premium",
  "currency": "BRL",
  "status": "active",
  "approvalMode": "manual",
  "publicSignupEnabled": false,
  "publicSlug": "programa-indique-e-ganhe-a1b2",
  "attributionModel": "last_click",
  "attributionWindowDays": 30,
  "holdDays": 30,
  "landingUrl": "https://exemplo.com/promo",
  "approvalDomainWhitelist": [
    "exemplo.com"
  ],
  "maxLinksPerAffiliate": 50,
  "couponAttributionPolicy": "coupon_wins",
  "commissionBasis": "gross",
  "createdAt": "2026-06-13T12:00:00.000Z",
  "updatedAt": "2026-06-13T12:00:00.000Z"
}