Developer Network

Documentação

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

Motivos de descadastramento

Removendo e editando os motivos de descadastramento do Email Marketing.

Listagem

Lista motivos de descadastramento de uma determinada conta

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

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "items":[
    {
      "id":"4fc8c919f2576437ed000001",
      "name":"N\u00e3o me cadastrei (ou n\u00e3o lembro de ter me cadastrado) para receber estas mensagens"
    },
    {
      "id":"4fc8c919f2576437ed000002",
      "name":"A frequ\u00eancia de mensagens recebidas \u00e9 muito alta"
    },
  ],
  "page":
    {
      "current":1,
      "total":1
    }
}

Detalhes

Detalhes de um determinado motivo de descadastramento

GET: https://DOMINIO/api/v1/accounts/ID_CONTA/unsubscribe_reasons/ID_MOTIVO_DESCADASTRAMENTO

Retorno de status HTTP: 200

Retorno:

1
2
3
4
5
6
{
  "id":"4fc8c919f2576437ed000001",
  "name":"N\u00e3o me cadastrei (ou n\u00e3o lembro de ter me cadastrado) para receber estas mensagens",
  "created_at":"12-06-01 10:52:25",
  "updated_at":"12-06-01 10:52:25"
}

Criação

Criação de motivo de descadastramento

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

Parametros:

1
2
3
4
5
{
  "unsubscribe_reason" : {
    "name" : "Nunca pedi para receber esse informativo"
  }
}

Retorno de status HTTP: 200

Retorno:

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

Edição

Atualiza determinado motivo de descadastramento

PUT: https://DOMINIO/api/v1/accounts/ID_CONTA/unsubscribe_reasons/ID_MOTIVO_DESCADASTRAMENTO

Parametros:

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

Retorno de status HTTP: 204

Retorno: “”

Remoção

Remover determinado motivo de descadastramento

DELETE: https://DOMINIO/api/v1/accounts/ID_CONTA/unsubscribe_reasons/ID_MOTIVO_DESCADASTRAMENTO

Retorno de status HTTP: 204

Retorno: “”