API de Integração
Campanhas

Ativar ou inativar campanha

Ativa ou inativa uma campanha, e permite trocar o `customIdentifier`. Envie só os campos que quer mudar. Ao inativar uma campanha com data de fim, a data de fim passa a ser o momento atual; ao reativá-la, a data de fim é removida. A resposta de sucesso é 204, sem corpo.

PATCH
/campaigns/active/{id}

Autorização

apiToken
Api-Token<token>

Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.

Local: header

Parâmetros de Path

id*string

ID da campanha (ObjectId de 24 caracteres hexadecimais, devolvido na criação).

Corresponde a^[a-f0-9]{24}$

Corpo da Requisição

application/json

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da Resposta

application/json

application/json

application/json

curl -X PATCH "https://example.com/campaigns/active/62040e573aafe90023d4143d" \  -H "Content-Type: application/json" \  -d '{    "active": false,    "customIdentifier": "custom_identifier_code"  }'
Vazio

Consultar campanha

Consulta uma campanha pelo ID.

Listar recebimentos

Lista os recebimentos do parceiro, por solicitação de crédito. Limite: 10 requisições por segundo por IP; acima disso a resposta é 429. Datas no formato `AAAA-MM-DD`. Os filtros `status`, `productType`, `courseId`, `delayedDay`, `delayedInstallment` e `campaign` podem ser repetidos. Veja os valores aceitos em **Listar filtros de recebimentos**.