Listagem

Listagem das listas de uma determinada conta.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/lists

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
{
  "page" : {
    "current" : 1,
    "total" : 1
  },
  "items" : [
    {
      "contacts_count" : 1,
      "id" : "4fa136a52c1e581220000005",
      "description" : "Descrição Lista 1",
      "name" : "Lista 1"
    },
    {
      "contacts_count" : 1000,
      "id" : "4f302e3f4cfc372a26000004",
      "description" : "Descrição Lista 2",
      "name" : "Lista 2"
    }
  ]
}

Detalhes

Detalhes de uma determinada lista.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/lists/ID_LISTA

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
{
  "contacts_count" : 1000,
  "id" : "4fda36bef147d60810000018",
  "created_at" : "12-01-01 00:00:00",
  "description" : "Descrição Lista 1",
  "updated_at" : "12-01-01 00:00:00",
  "name" : "Lista 1"
}

Criação

Criação de listas

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

Parametros:

1
2
3
4
5
6
{
  "list" : {
    "name" : "Lista 1",
    "description" : "Descricao lista 1"
  }
}

Retorno de status HTTP: 200

Retorno:

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

Edição

Atualizar determinada lista.

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/lists/ID_LISTA

Parametros:

1
2
3
4
5
6
{
  "list" : {
    "name" : "Alteração na Lista 1",
    "description" : "Alteração na Descricao da lista 1"
  }
}

Retorno de status HTTP: 204

Retorno: “”

Remoção

Remover determinada lista.

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/lists/ID_LISTA

Retorno de status HTTP: 204

Retorno: “”

Adicionar Contatos

Quando o email passado é de um usuário já cadastrado, ele é adicionado à lista. Caso seja enviado por parâmetro o hash com custom_fields, eles serão adicionaos ao contato. Se o parâmetro overwriteattributes é enviado com valor true, os custom_fields do contato serão sobrescritos.

Quando o email passado não estiver cadastrado, o contato será criado e adicionado à lista.

POST: http://DOMINIO/api/v1/accounts/ID_CONTA/lists/ID_LISTA/contacts

Parametros:

1
2
3
4
5
6
7
8
9
{
  "list" : {
    "contacts" : [
      {"email": "user1@locaweb.com.br", "custom_fields": {"name": "Alterar Nome email1"}},
      {"email": "email2@locaweb.com.br", "custom_fields": {"name": "Nome email2"} }
    ],
    "overwriteattributes" : true
  }
}

Retorno de status HTTP: 204

Retorno: “”

Remoção de Contatos

Remover contatos de uma determinada lista.

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/lists/ID_LISTA/remove_contacts

Parametros:

1
2
3
4
5
{
  "list" : {
    "contacts" : ["email1@locaweb.com.br"]
  }
}

Retorno de status HTTP: 204

Retorno: “”