Cria um afiliado em um programa

POST

programs

{programId}

affiliates

curl --request POST \
  --url https://api.userepass.com/programs/{programId}/affiliates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Maria Silva",
  "email": "[email protected]",
  "mode": "direct",
  "tier": "<string>",
  "importedTotalEarnedCents": 4503599627370495,
  "importedSince": "<unknown>"
}
'

import requests

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

payload = {
    "name": "Maria Silva",
    "email": "[email protected]",
    "mode": "direct",
    "tier": "<string>",
    "importedTotalEarnedCents": 4503599627370495,
    "importedSince": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Maria Silva',
    email: '[email protected]',
    mode: 'direct',
    tier: '<string>',
    importedTotalEarnedCents: 4503599627370495,
    importedSince: '<unknown>'
  })
};

fetch('https://api.userepass.com/programs/{programId}/affiliates', 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}/affiliates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Maria Silva',
    'email' => '[email protected]',
    'mode' => 'direct',
    'tier' => '<string>',
    'importedTotalEarnedCents' => 4503599627370495,
    'importedSince' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Maria Silva\",\n  \"email\": \"[email protected]\",\n  \"mode\": \"direct\",\n  \"tier\": \"<string>\",\n  \"importedTotalEarnedCents\": 4503599627370495,\n  \"importedSince\": \"<unknown>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.userepass.com/programs/{programId}/affiliates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Maria Silva\",\n  \"email\": \"[email protected]\",\n  \"mode\": \"direct\",\n  \"tier\": \"<string>\",\n  \"importedTotalEarnedCents\": 4503599627370495,\n  \"importedSince\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Maria Silva\",\n  \"email\": \"[email protected]\",\n  \"mode\": \"direct\",\n  \"tier\": \"<string>\",\n  \"importedTotalEarnedCents\": 4503599627370495,\n  \"importedSince\": \"<unknown>\"\n}"

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

{
  "id": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "organizationId": "org_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "programId": "prog_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "affiliateUserId": "user_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "name": "Maria Silva",
  "email": "[email protected]",
  "status": "approved",
  "tier": "gold",
  "customCommissionRuleId": "comm_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "acceptedTermsVersion": 3,
  "payoutMethod": "pix",
  "pixKey": "[email protected]",
  "pixKeyType": "email",
  "cnpj": "11222333000181",
  "importedTotalEarnedCents": 1990,
  "importedSince": "2026-06-13T12:00:00.000Z",
  "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

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

Body

application/json

name

string

required

Nome do afiliado.

Required string length: 1 - 120

Example:

"Maria Silva"

string<email>

required

E-mail do afiliado. Único por programa.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Example:

"[email protected]"

mode

enum<string>

default:direct

direct: cadastro imediato. invite: envia convite para o afiliado concluir o cadastro.

Available options:

direct,

invite

tier

string

Tier inicial do afiliado. Default: tier base do programa.

Minimum string length: 1

importedTotalEarnedCents

integer

Total histórico ganho (em centavos) ao importar de outra plataforma.

Required range: 0 <= x <= 9007199254740991

importedSince

any

Data de início do relacionamento ao importar de outra plataforma.

Response

201 - application/json

Default Response

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"

string

required

E-mail do afiliado. Único por programa.

Example:

"[email protected]"

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.

Example:

"[email protected]"

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"

Cria um afiliado em um programa

curl --request POST \
  --url https://api.userepass.com/programs/{programId}/affiliates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Maria Silva",
  "email": "[email protected]",
  "mode": "direct",
  "tier": "<string>",
  "importedTotalEarnedCents": 4503599627370495,
  "importedSince": "<unknown>"
}
'

import requests

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

payload = {
    "name": "Maria Silva",
    "email": "[email protected]",
    "mode": "direct",
    "tier": "<string>",
    "importedTotalEarnedCents": 4503599627370495,
    "importedSince": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Maria Silva',
    email: '[email protected]',
    mode: 'direct',
    tier: '<string>',
    importedTotalEarnedCents: 4503599627370495,
    importedSince: '<unknown>'
  })
};

fetch('https://api.userepass.com/programs/{programId}/affiliates', 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}/affiliates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Maria Silva',
    'email' => '[email protected]',
    'mode' => 'direct',
    'tier' => '<string>',
    'importedTotalEarnedCents' => 4503599627370495,
    'importedSince' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Maria Silva\",\n  \"email\": \"[email protected]\",\n  \"mode\": \"direct\",\n  \"tier\": \"<string>\",\n  \"importedTotalEarnedCents\": 4503599627370495,\n  \"importedSince\": \"<unknown>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.userepass.com/programs/{programId}/affiliates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Maria Silva\",\n  \"email\": \"[email protected]\",\n  \"mode\": \"direct\",\n  \"tier\": \"<string>\",\n  \"importedTotalEarnedCents\": 4503599627370495,\n  \"importedSince\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Maria Silva\",\n  \"email\": \"[email protected]\",\n  \"mode\": \"direct\",\n  \"tier\": \"<string>\",\n  \"importedTotalEarnedCents\": 4503599627370495,\n  \"importedSince\": \"<unknown>\"\n}"

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

{
  "id": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "organizationId": "org_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "programId": "prog_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "affiliateUserId": "user_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "name": "Maria Silva",
  "email": "[email protected]",
  "status": "approved",
  "tier": "gold",
  "customCommissionRuleId": "comm_01J9Z3K8N2QF4T7B9XP0WMD5RC",
  "acceptedTermsVersion": 3,
  "payoutMethod": "pix",
  "pixKey": "[email protected]",
  "pixKeyType": "email",
  "cnpj": "11222333000181",
  "importedTotalEarnedCents": 1990,
  "importedSince": "2026-06-13T12:00:00.000Z",
  "createdAt": "2026-06-13T12:00:00.000Z",
  "updatedAt": "2026-06-13T12:00:00.000Z"
}