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

Cria um novo afiliado

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
affiliate
Object

name

Obrigatório

String

Nome do afiliado

Ex: Influencer instagram
document

Obrigatório

String

CPF/CNPJ do afiliado

Ex: 38235467828
email

Obrigatório

String

Email do afiliado

Ex: [email protected]
phone_number
String

Telefone do afiliado

Ex: 11942424545
parent_affiliate_id
String

ID do afiliado que indicou

Ex: 0XNFWtBURoI7O5vinlYjS2
Exemplo 
1
2
3
4
5
6
7
8
9

{
  "affiliate": {
    "name": "Influencer instagram",
    "document": "38235467828",
    "email": "[email protected]",
    "phone_number": "11942424545",
    "parent_affiliate_id": "0XNFWtBURoI7O5vinlYjS2"
  }
}

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
201
Created
id
String

Identificador único do afiliado

Ex: 5N8wqsUjlwlxtx1tIqoP1a
name
String

Nome do afiliado

Ex: Primo Rico
workspace_id
String

ID do espaço de trabalho associado ao afiliado

Ex: 6AaVMPZBMTMweShgqdA7nR
email
String

Email do afiliado

Ex: [email protected]
phone_number
String

Telefone do afiliado

Ex: 11942424545
document
String

Documento do afiliado

Ex: 50949740098
created_at
String

Data e hora de criação do afiliado

Ex: 2023-12-20T17:46:49.461Z
updated_at
String

Data e hora da última atualização do afiliado

Ex: 2023-12-22T19:06:50.487Z
parent_affiliate
Object

id
String

Identificador único do afiliado indicador

Ex: 0XNFWtBURoI7O5vinlYjS2
name
String

Nome do afiliado indicador

Ex: Primo Rico
email
String

Email do afiliado indicador

Ex: [email protected]
document
String

Documento do afiliado indicador

Ex: 50949740098
422
Unprocessable Entity
name
Array of strings

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

Ex: [não pode ficar em branco]
email
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 afiliados

Avançar

Atualiza um afiliado