Listagem

Listagem dos campos personalizados de uma determinada conta

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/custom_fields
Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "items": [
    {
      "id": "500dae5d38a582354e000005",
      "name": "Nome",
      "type": "string"
    },
    {
      "id": "500dae5d38a582354e000006",
      "name": "Cidade",
      "type": "string"
    },
    {
      "id": "500dae5d38a582354e000007",
      "name": "Data de nascimento",
      "type": "date"
    }
  ],
  "page": {
    "current": 1,
    "total": 1
  }
}

Detalhes

Detalhes de um determinado campo personalizado

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/custom_fields/ID_CAMPO_PERSONALIZADO
Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
{
  "id": "500dae5d38a582354e000005",
  "name": "Nome",
  "type": "string",
  "created_at": "12-07-23 17:04:45",
  "updated_at": "12-07-23 17:04:45"
}

Criação

Criação de campo personalizado.

POST: https://DOMINIO/api/v1/accounts/ID_CONTA/custom_fields

Parametros:

1
2
3
4
5
6
{
  "custom_field" : {
    "name": "Nome",
    "type": "string"
  }
}

Tipos disponíveis: boolean, date, number ou string.

Retorno de status HTTP: 200

Retorno:

1
2
3
{
 "id" : "4fe3684e2c1e5806df000001"
}

Edição

Atualizar determinado campo personalizado.

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/custom_fields/ID_CAMPO_PERSONALIZADO

Retorno:

1
2
3
4
5
{
  "custom_field" : {
   "name" : "Sobrenome"
  }
}

Retorno de status HTTP: 204

Retorno: “”

Remoção

Remover determinado campo personalizado.

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/custom_fields/ID_CAMPO_PERSONALIZADO

Retorno de status HTTP: 204

Retorno: “”