Developer Network

Documentação

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

Mensagens

Editando e criando via API as mensagens de Email Marketing.

Listagem

Listagem das mensagens de uma determinada conta.

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

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" : "Rascunho",
      "id" : "4fe1fc636003d835c0000001",
      "name" : "Mensagem 3"
    },
    {
      "status" : "Agendada",
      "id" : "4fe0736e6e89900a5b000001",
      "name" : "Mensagem 2"
    },
    {
      "status" : "Enviada",
      "id" : "4fe0d7986e8990039c000002",
      "name" : "Mensagem 1"
    }
  ]
}

Detalhes

Detalhes de uma determinada mensagem.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/messages/ID_MENSAGEM

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
{
  "id" : "4fe0d7986e8990039c000002",
  "preview" : "http://DOMINIO/messages/4fe0d7986e8990039c000002?c=1340135320",
  "text_body" : "Conteúdo da mensagem em texto",
  "lists" : [
    {
      "contacts_count" : 1000,
      "id" : "4fdf8f272ea5d40551000025",
      "description" : "Descrição de Lista 1",
      "name" : "Lista 1"
    }
  ],
  "contacts_count" : 1000,
  "scheduled_to" : "12-01-02 00:00:00",
  "created_at" : "12-01-01 00:00:00",
  "domain" : "DOMINIO",
  "html_body" : "<p>Conteúdo da mensagem em HTML<p>",
  "updated_at" : "12-01-01 00:00:00",
  "sender" : "Destinatário <from@locaweb.com.br>",
  "status" : "Enviada",
  "name" : "Mensagem 1"
}

Criação

Criação de mensagens.

O parametro scheduled_to pode ser passado como uma data e hora especifica ou a string “now” para envio imediato.

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

Parametros:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "message": {
    "campaign_id": "1",
    "domain_id": "4fe4dc122c1e5806df000010",
    "html_body": "<p>Conteúdo da mensagem em HTML<p>",
    "text_body": "Conteúdo TEXTO",
    "list_ids": ["4fa136a52c1e581220000005"],
    "name": "Mensagem 1",
    "sender_name": "Nome do destinatário",
    "sender": "remetente@locaweb.com.br",
    "subject": "Assunto Mensagem 1",
    "scheduled_to": "2012/01/01 00:00:00"
  }
}

Retorno de status HTTP: 200

Retorno:

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

Edição

Atualizar determinado mensagem.

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/messages/ID_MENSAGEM

Parametros:

1
2
3
4
5
6
7
8
9
10
11
12
{
  "message": {
    "domain_id": "4f3d238d4cfc371414000002",
    "html_body": "<p>Conteúdo da mensagem em HTML<p>",
    "text_body": "Conteúdo TEXTO Alterado",
    "list_ids": ["4fe368c32c1e5806df000003"],
    "name": "Mensagem 1 Alterada",
    "sender_name": "Nome do destinatário Alterado",
    "sender": "remetente@locaweb.com.br",
    "subject": "Assunto Mensagem 1 Alterada"
  }
}

Retorno de status HTTP: 204

Retorno: “”

Remoção

Remover determinado mensagem.

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/messages/ID_MENSAGEM

Retorno de status HTTP: 204

Retorno: “”