Docs
App Afiliados
API
post https://api.affiliates.iugu.com/campaigns

Cria uma nova campanha

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Schema Obrigatório

Tipo de conteúdo: application/json
campaign
Object

name

Obrigatório

String

Nome da campanha

Ex: Campanha de Verão
event

Obrigatório

String

Tipo de evento

Ex: Pix
kind

Obrigatório

Integer

Tipo de premiação (percent: 1, fixed: 2)

Ex: 2
amount

Obrigatório

Number

Valor da premiação por evento

Ex: 0.1
start_date

Obrigatório

String

Data de início da campanha

Ex: 2023-12-09
end_date
String

Data de término da campanha

Ex: 2023-12-13
level_config
Object

Configuração de níveis de premiação
level_1
Integer

Configuração do nível 1

Ex: 50
level_2
Integer

Configuração do nível 2

Ex: 50
Exemplo 
1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "campaign": {
    "name": "Campanha de Verão",
    "event": "Pix",
    "kind": 2,
    "amount": 0.1,
    "start_date": "2023-12-09",
    "end_date": "2023-12-13",
    "level_config": {
      "level_1": 50,
      "level_2": 50
    }
  }
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
201
Created
id
String

ID da campanha

Ex: 58HKqRy8w2iHoKT91HCIeI
name
String

Nome da campanha

Ex: Campanha de Verão
workspace_id
String

ID da Área de Trabalho

Ex: 6AaVMPZBMTMweShgqdA7nR
event
String

Tipo de evento

Ex: Pix
kind
Integer

Tipo de premiação (percent: 1, fixed: 2)

Ex: 2
amount
Number

Valor da premiação por evento

Ex: 0.1
start_date
String

Data de início da campanha

Ex: 2023-12-09
end_date
String

Data de término da campanha

Ex: 2023-12-13
level_config
Object

Configuração de níveis de premiação
level_1
Integer

Configuração do nível 1

Ex: 50
level_2
Integer

Configuração do nível 2

Ex: 50
affiliates
Array of strings

Array de ID de afiliados

Ex: ["5EufttluGZIPaQKN5PF4X4", "0cxvXAS3uPZut5z1mVKI20"]
created_at
String

Data de criação da campanha

Ex: 2023-12-08T16:41:22.922Z
updated_at
String

Data de atualização da campanha

Ex: 2023-12-08T16:44:02.572Z
422
Unprocessable Entity
name
Array of strings

Ex: ["não pode ficar em branco"]
event
Array of strings

Ex: ["não pode ficar em branco"]
kind
Array of strings

Ex: ["não pode ficar em branco","não é válido"]
amount
Array of strings

Ex: ["não pode ficar em branco","não é válido"]
start_date
Array of strings

Ex: ["não pode ficar em branco","não é válido"]
401
Unauthorized
status
String

Ex: 401
title
String

Ex: JWT VALIDATION ERROR
detail
String

Ex: Signature has expired
500
Internal Server Error
status
String

Ex: 500
title
String

Ex: Internal Server Error
detail
String

Ex: Internal Error, try again later

Voltar

Retorna uma lista de campanhas

Avançar

Consulta uma campanha