Informações e instruções das APIs dos produtos Locaweb.
Listagem e manipulação de detalhes de contatos.
Listagem dos contatos de uma determinada conta.
GET: https://DOMINIO/api/v1/accounts/ID_CONTA/contacts
Retorno de status HTTP: 200
Retorno:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"page" : {
"current" : 1,
"total" : 1
},
"items" : [
{
"id" : "4f88693f46f9742c3f000001",
"email" : "email1@locaweb.com.br"
},
{
"id" : "4f88693f46f9742c3f000002",
"email" : "email2@locaweb.com.br"
}
]
}
Detalhes de um determinado contato.
GET: https://DOMINIO/api/v1/accounts/ID_CONTA/contacts/ID_CONTATO
Retorno de status HTTP: 200
Retorno:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"status" : "approved",
"clicks_count" : 0,
"custom_fields" : {
"nasc" : "01/01/2012",
"city" : "São Paulo",
"name" : "Usuário 1"
},
"id" : "4f88693f46f9742c3f000001",
"openings_count" : 0,
"uniq_openings_count" : 0,
"bounces_count" : 0,
"email" : "email1@locaweb.com.br",
"created_at" : "12-01-01 00:00:00",
"updated_at" : "12-01-01 00:00:00"
}
Criação de contatos
POST: https://DOMINIO/api/v1/accounts/ID_CONTA/contacts
Parametros:
1
2
3
4
5
6
7
8
9
10
11
{
"contact": {
"email": "email1@locaweb.com.br",
"list_ids": ["4fa136a52c1e581220000005"],
"custom_fields": {
"nome": "Usuário 1",
"cidade": "São Paulo",
"data_de_nascimento": "01/01/2012"
}
}
}
Retorno de status HTTP: 200
Retorno:
1
2
3
{
"id" : "4fe3684e2c1e5806df000001"
}
Atualizar determinado contato.
PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/contacts/ID_CONTATO
Parametros:
1
2
3
4
5
6
7
8
9
10
{
"contact": {
"list_tokens": "4fa136a52c1e581220000005,4fa136a52c1e581220000006",
"custom_fields": {
"nome": "Usuário 1 Alterado",
"cidade": "Rio de Janeiro",
"data_de_nascimento": "02/02/2012"
}
}
}
Retorno de status HTTP: 204
Retorno: “”
Remover determinado contato.
DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/contacts/ID_CONTATO
Retorno de status HTTP: 204
Retorno: “”