Developer Network

Documentação

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

Templates

Listando, detalhando e removendo templates de Email Marketing.

Listagem

Lista templates de uma determinada conta

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/my_templates.

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
 {
   "items":[
       {
           "id":"4fe8b64ef257642049000006",
           "name":"Natal"
       }
   ],
   "page":
   {
       "current":1,
       "total":1
   }
}

Detalhes

Detalhes de um determinado template.

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/my_templates/ID_TEMPLATE

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
{
  "id":"4fe8b64ef257642049000006",
  "name":"Natal",
  "html_body":"",
  "text_body":"Feliz natal",
  "created_at":"12-06-25 16:04:47",
  "updated_at":"12-06-25 16:04:47"
 }

Criação

Criação de template.

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

Parametros:

1
2
3
4
5
6
7
 {
   "my_template" : {
     "name" : "Carnaval",
     "html_body" : "Feliz carnaval",
     "text_body" : "Feliz carnaval"
   }
 }

Retorno de status HTTP: 200

Retorno:

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

Edição

Atualiza determinado template.

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/my_templates/ID_TEMPLATE

Parametros:

1
2
3
4
5
{
  "my_template" : {
    "name" : "nova descricao"
  }
}

Retorno de status HTTP: 204

Retorno: “”

Remoção

Remover determinado template.

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/my_templates/ID_TEMPLATE

Retorno de status HTTP: 204

Retorno: “”