Docs
post https://api.affiliates.iugu.com/api/affiliates

Cria um novo afiliado

Sem ações implementadas definidas

Request

Headers

workspace_id

Required

Type: string

Identificador do workspace

Ex: 4fHECmQtLdROI4fDLWMiLd

Body Required

Content Type: application/json

affiliate
Object

name

Required

String

Nome do afiliado

Ex: Influencer instagram

document

Required

String

CPF/CNPJ do afiliado

Ex: 38235467828

email

Required

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

Example
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"
  }
}

Response

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

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "id": "5N8wqsUjlwlxtx1tIqoP1a",
  "name": "Primo Rico",
  "workspace_id": "6AaVMPZBMTMweShgqdA7nR",
  "email": "[email protected]",
  "phone_number": "11942424545",
  "document": "50949740098",
  "created_at": "2023-12-20T17:46:49.461Z",
  "updated_at": "2023-12-22T19:06:50.487Z",
  "parent_affiliate": {
    "id": "0XNFWtBURoI7O5vinlYjS2",
    "name": "Primo Rico",
    "email": "[email protected]",
    "document": "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]

Example
1
2
3
4
5
{
  "name": "[não pode ficar em branco]",
  "document": "[não pode ficar em branco]",
  "email": "[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

Example
1
2
3
4
5
{
  "status": "401",
  "title": "JWT VALIDATION ERROR",
  "detail": "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

Example
1
2
3
4
5
{
  "status": "500",
  "title": "Internal Server Error",
  "detail": "Internal Error, try again later"
}