Developer Network

Documentação

Informações e instruções das APIs dos produtos Locaweb.

Remetentes

Listagem e manipulação de detalhes de remetentes.

Listagem

Lista dos remetentes de uma determinada conta.

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

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
{
  "page" : {
    "current" : 1,
    "total" : 1
  },
  "items" : [
    {
      "status" : "approved",
      "id" : "4fe0c33e6e899011a1000002",
      "email" : "remetente1@locaweb.com.br"
    },
    {
      "status" : "approved",
      "id" : "4fd1f7492c1e5803aa000016",
      "email" : "remetente2@locaweb.com.br"
    },
    {
      "status" : "pending",
      "id" : "4fa2c0fbfcdf1d023c000009",
      "email" : "remetente3@locaweb.com.br"
    }
  ]
}

Detalhes

Detalhes de um determinado remetente.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/senders/ID_DESTINATARIO

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
{
  "status" : "approved",
  "id" : "4fe0c33e6e899011a1000002",
  "created_at" : "12-01-01 00:00:00",
  "email" : "remetente1@asdf.com.br",
  "updated_at" : "12-01-01 00:00:00"
}

Criar

Criação de remetentes

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

Parametros:

1
2
3
4
5
{
  "sender": {
    "email": "remetente1@locaweb.com.br"
  }
}

Retorno de status HTTP: 200

Retorno:

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

Remover remetente

Remover determinado remetente.

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/senders/ID_DESTINATARIO

Retorno de status HTTP: 204

Retorno: “”