Back to top

Gerencie as informações de sua conta.

Autenticação

A autenticação é realizada através da inclusão do parâmetro “chave” na URL. Esta chave pode ser gerada no sistema, na seção "Chaves da API". Exemplo:

$ curl -X GET https://api.criaenvio.com/v1/campos?chave=V2FASZTf208fhs98cwuTVZ4WHcuZkcwMWguDssY=

Parâmetros

Para requisições POST e PUT, os parâmetros não incluidos na URL devem ser codificados em JSON com um header "Content-Type: application/json". Exemplo:

$ curl -X PUT -H "Content-Type:application/json" -d '{"campo": "Valor"}' https://api.criaenvio.com

Paginação

Requisições que retornam múltiplos itens serão paginadas com 30 itens por padrão. Você pode especificar as páginas através do parâmetro "page". Para alguns recursos você pode definir um tamanho de página, com um limite superior de 100 itens, através do parâmetro "number".

Essas requisições acompanham um objeto JSON chamado "pagination", com informações adicionais sobre a paginação. Exemplo:

    ...,
    pagination: {
        total: 18
        count: 18
        per_page: 30
        current_page: 1
        total_pages: 1
        links: [ ]
    }

Abaixo serão detalhados os recursos existentes na API.

Contatos 

Destinatários para os quais as mensagens são enviadas.

Contato 

Visualizar
/contatos/{id}?{embeds}

Visualiza um único contato.

  • Parameters
  • id
    string (required) Example: ioddw4

    ID do contato

    embeds
    string (optional) Example: grupos

    Dados relacionados

    Choices: grupos campos

  • Response  200
  • Body
    {
        "data": {
                    "id": "idasd",
                    "nome": "Editado",
                    "email": "emailteste@gmail.com",
                    "qualidade": "2",
                    "ativo": false,
                    "descadastrado": false,
                    "sexo": "m",
                    "dataNascimento": "2012-02-02",
                    "dataCadastro": "2014-03-10 18:20:12"
                }
    }
    
    ou
    
    {
        "data": {
                    "id": "idasd",
                    "nome": "Editado",
                    "email": "emailteste@gmail.com",
                    "qualidade": "2",
                    "ativo": false,
                    "descadastrado": false,
                    "sexo": "m",
                    "dataNascimento": "2012-02-02",
                    "dataCadastro": "2014-03-10 18:20:12"
                    "campos": {
                                "data": [
                                    {
                                        "id": "ifafe",
                                        "nome": "campo personalizado 1",
                                        "valor": "valor do campo para este contato"
                                    },
                                    {
                                        "id": "itota",
                                        "nome": "campor personalizado 2",
                                        "valor": "valor deste outro campo para este contato"
                                    },
                                ]
                            }
                }
    }
    
    ou
    
    {
        "data": {
                    "id": "idasd",
                    "nome": "Editado",
                    "email": "emailteste@gmail.com",
                    "qualidade": "2",
                    "ativo": false,
                    "descadastrado": false,
                    "sexo": "m",
                    "dataNascimento": "2012-02-02",
                    "dataCadastro": "2014-03-10 18:20:12"
                    "grupos": {
                                "data": [
                                    {
                                        "id": "iGfd",
                                        "nome": "Nome da Lista",
                                        "ativo": true,
                                        "contatos_ativos": "3212"
                                    },
                                    {
                                        "id": "iZip",
                                        "nome": "Nome de Outra Lista",
                                        "ativo": true,
                                        "contatos_ativos": "1530"
                                    },
                                ],
                                "pagination":
                                              {
                                                ...
                                              }
                              }
        }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    
  • Response  500
  • Body
    {
        "error": {
                    "code":"04-ERRO-INTERNO",
                    "http_code":500,
                    "message":"Internal Error"
                 }
    }
    
Atualizar
/contatos/{id}?{embeds}

Atualiza um contato.

  • Parameters
  • id
    string (required) Example: ioddw4

    ID do contato

    embeds
    string (optional) Example: grupos

    Dados relacionados

    Choices: grupos campos

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "nome": "novo nome para contato",
        "sexo": "m",
        "data_de_nascimento": "02/02/2012"
    }
    
  • Response  200
  • Body
        {
            "data": {
                "OK": "OK"
            }
        }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Já existe um contato com este email. Tente atualizá-lo."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Não é possível editar o e-mail de um contato que já recebeu envios."
                 }
    }
    

Criar 

Criar
/contatos

Cria um novo contato.

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "nome": "novo contato",
        "email": "emailteste@hotmail.com",
        "sexo": "f",
        "data_de_nascimento": "02/02/2012"
    }
    
  • Response  200
  • Body
    {
        "data" : {
                    "id": "Fssd12",
                    "nome": "novo contato",
                    "email": "emailteste@hotmail.com",
                    "sexo": "f",
                    "data_de_nascimento": "02/02/2012"
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Já existe um contato com este email. Tente atualizá-lo."
                 }
    }
    

Buscar 

Buscar
/contatos{?id,nome,email,sexo,idadeinicio,idadetermino,datadecadastroinicio,datadecadastrotermino,datadenascimentoinicio,datadenascimentotermino,aniversarioinicio,aniversariotermino,status,qualidade,campo}

Busca contatos.

  • Parameters
  • id
    string (optional) Example: io4,sd0

    Lista de IDs de contatos, separados por vírgula

    nome
    string (optional) Example: Campo de teste

    Nome do contato

    email
    string (optional) Example: @yahoo.com

    E-mail do contato

    sexo
    string (optional) Example: m

    Sexo do contato

    Choices: m f mf vazio

    idadeinicio
    integer (optional) Example: 18

    Idade mínima do contato

    idadetermino
    integer (optional) Example: 70

    Idade máxima do contato

    datadecadastroinicio
    string (optional) Example: 10/01/2010

    Data de cadastro mínima do contato

    datadecadastrotermino
    string (optional) Example: 10/01/2014

    Data de cadastro máxima do contato

    datadenascimentoinicio
    string (optional) Example: 10/01/1986

    Data de nascimento mínima do contato

    datadenascimentotermino
    string (optional) Example: 10/01/1999

    Data de nascimento máxima do contato

    aniversarioinicio
    string (optional) Example: 31/01

    Faixa inferior do aniversário do contato

    aniversariotermino
    string (optional) Example: 31/01

    Faixa superior do aniversário do contato

    status
    string (optional) Default: ativos Example: todos

    Status do contato

    Choices: ativos inativos descadastros todos

    qualidade
    string (optional) Example: 5,6,7

    Lista de valores, separados por vírgula

    campo
    string (optional) Example: valor do campo

    Valor de um campo personalizado

  • Response  200
  • Body
    {
        "data": [
                    {
                        "id":"k",
                        "nome":"Editado",
                        "email":"outroemail@hotmail.com",
                        "qualidade":"2",
                        "ativo":true,
                        "descadastrado":false,
                        "sexo":"m",
                        "dataNascimento":"2012-02-02",
                        "dataCadastro":"2013-01-20 09:27:05"
                    },
                    {
                        "id":"E",
                        "nome":"",
                        "email":"email@hotmail.com",
                        "qualidade":"5",
                        "ativo":true,
                        "descadastrado":false,
                        "sexo":null,
                        "dataNascimento":null,
                        "dataCadastro":"2014-02-18 18:58:10"
                    }
                ],
        "pagination":
                  {
                    ...
                  }
    }
    

Ativar 

Ativar
/contatos/{id}/ativar

Ativa um contato.

Atenção: Não é possível ativar um contato descadastrado.

  • Parameters
  • id
    string (required) Example: io4

    ID do contato

  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
  • Response  401
  • Body
    {
        "error": {
                    "code":"03-NAO-AUTORIZADO",
                    "http_code":401,
                    "message":"Não é possível ativar um contato descadastrado."
                 }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    

Desativar 

Desativar
/contatos/{id}/desativar

Desativa um contato.

  • Parameters
  • id
    string (required) Example: io4

    ID do contato

  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    

Inscrever em lista 

Inscrever em lista
/contatos/{id}/inscrever

Inscreve o contato em uma ou mais listas.

  • Parameters
  • id
    string (required) Example: io4

    ID do contato

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "idGrupos": "io4, lis2, jj",
    }
    
  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Não foram encontrado os ids de grupos."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Limite de registros excedido."
                 }
    }
    

Desinscrever de lista 

Desiscrever de lista
/contatos/{id}/desinscrever

Desinscreve o contato de uma ou mais listas.

  • Parameters
  • id
    string (required) Example: io4

    ID do contato

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "idGrupos": "io4, lis2, jj",
    }
    
  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Não foram encontrado os ids de grupos."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Limite de registros excedido."
                 }
    }
    

Atualizar campos personalizados 

Atualizar campos personalizados
/contatos/{id}/atualizarCampos

Atualiza os campos personalizados do contato.

  • Parameters
  • id
    string (required) Example: io4

    ID do contato

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "campos": {
            "iof": "valor para o campo",
            "io4k": "outro valor"
        }
    }
    
  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"É necessário informar ao menos um campo para realizar a atualização."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Limite de registros excedido."
                 }
    }
    

Listas 

Conjunto de contatos.

Lista 

Visualizar
/grupos/{id}?{embeds,status}

Visualiza uma única lista.

  • Parameters
  • id
    string (required) Example: io4

    ID da lista

    embeds
    string (optional) Example: contatos

    Dados relacionados

    Choices: contatos

    status
    string (optional) Default: ativos Example: todos

    Status dos contatos inscritos

    Choices: inativos descadastros todos ativos

  • Response  200
  • Body
    {
        "data": {
                    "id": "io4",
                    "nome": "Nome da lista",
                    "ativo": true,
                    "contatos_ativos": "22"
                }
    }
    
    ou
    
    {
        "data": {
                    "id": "io4",
                    "nome": "Nome da lista",
                    "ativo": true,
                    "contatos_ativos": "22",
                    "contatos": {
                                "data": [
                                    {
                                        "id":"k",
                                        "nome":"Editado",
                                        "email":"outroemail@hotmail.com",
                                        "qualidade":"2",
                                        "ativo":true,
                                        "descadastrado":false,
                                        "sexo":"m",
                                        "dataNascimento":"2012-02-02",
                                        "dataCadastro":"2013-01-20 09:27:05"
                                    },
                                    {
                                        "id":"E",
                                        "nome":"",
                                        "email":"email@hotmail.com",
                                        "qualidade":"5",
                                        "ativo":true,
                                        "descadastrado":false,
                                        "sexo":null,
                                        "dataNascimento":null,
                                        "dataCadastro":"2014-02-18 18:58:10"
                                    }
                                    ],
                                    "pagination":
                                        {
                                            ...
                                        }
                                }
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    
Atualizar
/grupos/{id}?{embeds,status}

Atualiza uma lista.

  • Parameters
  • id
    string (required) Example: io4

    ID da lista

    embeds
    string (optional) Example: contatos

    Dados relacionados

    Choices: contatos

    status
    string (optional) Default: ativos Example: todos

    Status dos contatos inscritos

    Choices: inativos descadastros todos ativos

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "nome": "Novo nome da lista"
    }
    
  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    

Criar 

Criar
/grupos

Cria uma nova lista.

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "nome": "Nome da nova lista"
    }
    
  • Response  200
  • Body
    {
        "data" : {
                    "id": "FHId12",
                    "nome": "Nome da nova lista",
                    "ativo": true,
                    "contatos_ativos": "0"
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    

Buscar 

Buscar
/grupos{?id,nome,ativo}

Busca listas.

  • Parameters
  • id
    string (optional) Example: io4,sd0

    Lista de IDs de listas, separados por vírgula

    nome
    string (optional) Example: Campo de teste

    Nome da lista

    ativo
    string (optional) Default: true Example: true

    Status da lista

    Choices: true false

  • Response  200
  • Body
    {
        "data": [
                    {
                        "id": "DHIda",
                        "nome": "Campo de teste",
                        "ativo": true,
                        "contatos_ativos": "21"
                    },
                    {
                        "id": "io4",
                        "nome": "Lista de Exemplo",
                        "ativo": true,
                        "contatos_ativos": "11"
                    }
                ],
        "pagination":
                  {
                    ...
                  }
    }
    

Ativar 

Ativar
/grupos/ativar?{id}

Ativa uma ou mais listas.

  • Parameters
  • id
    string (required) Example: io4,sd0

    Lista de IDs de listas, separados por vírgula

  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Argumentos inválidos."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    

Desativar 

Desativar
/grupos/desativar?{id}

Desativa uma ou mais listas.

  • Parameters
  • id
    string (required) Example: io4,sd0

    Lista de IDs de listas, separados por vírgula

  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Argumentos inválidos."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    

Campos personalizados 

Índices utilizados para definir os atributos de um contato.

Campo personalizado 

Visualizar
/campos/{id}

Visualiza um único campo personalizado.

  • Parameters
  • id
    string (required) Example: d12I4

    ID do campo personalizado

  • Response  200
  • Body
    {
        "data": {
                    "id": "d12I4",
                    "nome": "Nome do campo personalizado"
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Campo personalizado não encontrado."
                 }
    }
    
Atualizar
/campos/{id}

Atualiza um campo personalizado.

  • Parameters
  • id
    string (required) Example: d12I4

    ID do campo personalizado

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "nome": "Novo nome do campo personalizado"
    }
    
  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Campo personalizado não encontrado."
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"O nome do campo deve ser informado."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
Remover
/campos/{id}

Remove um campo personalizado.

Atenção: Essa ação remove permanentemente todas as informações do campo personalizado.

  • Parameters
  • id
    string (required) Example: d12I4

    ID do campo personalizado

  • Response  200
  • Body
        {
            "data": {
                        "OK": "OK"
                    }
        }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Campo personalizado não encontrado."
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    

Criar 

Criar
/campos

Cria um novo campo personalizado.

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "nome": "Nome do campo personalizado"
    }
    
  • Response  200
  • Body
    {
        "data" : {
                    "id": "FHId12",
                    "nome": "Nome do campo personalizado"
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    

Buscar 

Buscar
/campos{?id,nome}

Busca campos personalizados.

  • Parameters
  • id
    string (optional) Example: d12I4

    ID do campo personalizado

    nome
    string (optional) Example: Campo de teste

    Nome do campo personalizado

  • Response  200
  • Body
    {
        "data": [
                    {
                        "id": "DHIda",
                        "nome": "Campo de teste"
                    },
                    {
                        "id": "ASDdh1",
                        "nome": "Mês de aniversário"
                    }
                ],
        "pagination":
                  {
                    ...
                  }
    }
    

Remetentes 

E-mails remetentes configurados na conta.

Buscar 

Buscar
/remetentes{?id,nome,email}

Busca remetentes.

  • Parameters
  • id
    string (optional) Example: d12I4

    ID do remetente

    nome
    string (optional) Example: Nome da Conta

    Nome do remetente

    email
    string (optional) Example: email@conta.com

    E-mail do remetente

  • Response  200
  • Body
    {
        "data": [
                    {
                        "id": "Eo",
                        "nome": "Nome do remetente",
                        "email": "email@remetente.com.br",
                        "principal": true,
                        "confirmado": true
                    },
                    {
                        "id": "Xo",
                        "nome": "Nome do remetente 2",
                        "email": "email2@remetente.com.br",
                        "principal": false,
                        "confirmado": true
                    }
                ],
        "pagination":
                  {
                    ...
                  }
    }
    

Mensagens 

Mensagens da conta.

Mensagem 

Visualizar
/mensagens/{id}

Visualiza uma única mensagem.

  • Parameters
  • id
    string (required) Example: sd

    ID da mensagem

  • Response  200
  • Body
    {
        "data": {
                    "assunto": "Novo teste",
                    "contador": "22",
                    "dataCadastro": "2015-02-02",
                    "emailResposta": "email@resposta.com",
                    "id": "-q",
                    "html": "html da mensagem",
                    "jaEnviada": true,
                    "mensagemDescadastro": "caso queira sair da lista",
                    "nome": "Nome da mensagem"
                }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Mensagem não encontrada."
                 }
    }
    
Atualizar
/mensagens/{id}

Atualiza uma mensagem.

Observação: Ao atualizar uma mensagem que já foi enviada, o sistema cria uma nova mensagem por fins de referência a versão antiga.

  • Parameters
  • id
    string (required) Example: -j

    ID da mensagem

    assunto
    string (optional) Example: Assunto teste

    Assunto da mensagem

    html
    string (optional) Example: Dia das mães

    HTML da mensagem

    nome
    string (optional) Example: Nome da newsletter

    Nome secundário da mensagem

    email_resposta
    string (optional) Example: email@teste.com

    E-mail de resposta da mensagem

    mensagem_descadastro
    string (optional) Example: Quer sair?

    Mensagem localizada antes do link de cancelamento

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "assunto": "Assunto da mensagem",
        "html": "<html><body>Corpo da mensagem</body></html>",
        "nome": "Nome secundário da mensagem",
        "email_resposta": "email@resposta.com.br",
        "mensagem_descadastro": "Deseja sair da lista? Clique ao lado"
    }
    
  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK",
                    "registro" : {
                                    "id": "-X",
                                    "contador": "112",
                                    "assunto": "Assunto da mensagem",
                                    "html": "<html><body>Corpo da mensagem</body></html>",
                                    "nome": "Nome secundário da mensagem",
                                    "dataCadastro": "2015-07-21",
                                    "emailResposta": "email@resposta.com.br",
                                    "mensagemDescadastro": "Deseja sair da lista? Clique ao lado",
                                    "jaEnviada": false
                                 }
                }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Tamanho de mensagem excedido."
                 }
    }      
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Mensagem não encontrada."
                 }
    }
    
  • Response  500
  • Body
    {
        "error": {
                    "code":"04-ERRO-INTERNO",
                    "http_code":500,
                    "message":"Falha ao calcular o tamanho da mensagem. Tente mais tarde."
                 }
    }           
    
Remover
/mensagens/{id}

Remove uma mensagem.

Atenção: Apenas mensagens que não foram enviadas podem ser removidas.

  • Parameters
  • id
    string (required) Example: sd

    ID da mensagem

  • Response  200
  • Body
        {
            "data": {
                        "OK": "OK"
                    }
        }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Mensagem não encontrada."
                 }
    }
    
  • Response  401
  • Body
    {
        "error": {
                    "code":"03-NAO-AUTORIZADO",
                    "http_code":401,
                    "message":"Não é possível remover uma mensagem que já foi enviada."
                 }
    }            
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":404,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    

Criar 

Criar
/mensagens

Cria uma nova mensagem.

  • Parameters
  • assunto
    string (required) Example: Assunto teste

    Assunto da mensagem

    html
    string (required) Example: Dia das mães

    HTML da mensagem

    nome
    string (optional) Example: Nome da newsletter

    Nome secundário da mensagem

    email_resposta
    string (optional) Example: email@teste.com

    E-mail de resposta da mensagem

    mensagem_descadastro
    string (optional) Example: Quer sair?

    Mensagem localizada antes do link de cancelamento

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "assunto": "Assunto da mensagem",
        "html": "<html><body>Corpo da mensagem</body></html>",
        "nome": "Nome secundário da mensagem",
        "email_resposta": "email@resposta.com.br",
        "mensagem_descadastro": "Deseja sair da lista? Clique ao lado"
    }
    
  • Response  200
  • Body
    {
        "data" : {
                    "id": "-X",
                    "contador": "112",
                    "assunto": "Assunto da mensagem",
                    "html": "<html><body>Corpo da mensagem</body></html>",
                    "nome": "Nome secundário da mensagem",
                    "dataCadastro": "2015-07-21",
                    "emailResposta": "email@resposta.com.br",
                    "mensagemDescadastro": "Deseja sair da lista? Clique ao lado",
                    "jaEnviada": false
                 }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Campo assunto/html não preenchido."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Erro ao processar requisição. Detalhe(s): ..."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Tamanho de mensagem excedido."
                 }
    }      
    
  • Response  500
  • Body
    {
        "error": {
                    "code":"04-ERRO-INTERNO",
                    "http_code":500,
                    "message":"Falha ao calcular o tamanho da mensagem. Tente mais tarde."
                 }
    } 
    

Buscar 

Buscar
/mensagens{?id,assunto,nome,contador,datadecadastroinicio,datadecadastrotermino}

Busca mensagens.

  • Parameters
  • id
    string (optional) Example: d12I4,-W

    ID(s) da mensagem

    assunto
    string (optional) Example: Dia das mães

    Assunto da mensagem

    nome
    string (optional) Example: Nome exemplo

    Nome da mensagem

    contador
    string (optional) Example: 92

    Lista de contadores da mensagem

    datadecadastroinicio
    string (optional) Example: 10/01/2010

    Data de cadastro mínima da mensagem

    datadecadastrotermino
    string (optional) Example: 10/01/2015

    Data de cadastro máxima da mensagem

  • Response  200
  • Body
    {
        "data": [
                    {
                        "assunto": "Novo teste",
                        "contador": "22",
                        "dataCadastro": "2015-02-02",
                        "emailResposta": "email@resposta.com",
                        "id": "-q",
                        "jaEnviada": true,
                        "mensagemDescadastro": "caso queira sair da lista",
                        "nome": "Nome da mensagem"
                    },
                    {
                        "assunto": "Novo Teste 2",
                        "contador": "94",
                        "dataCadastro": "2015-03-06",
                        "emailResposta": "email@resposta.com",
                        "id": "-W",
                        "jaEnviada": false,
                        "mensagemDescadastro": "caso queira sair da lista",
                        "nome": null
                    }
                ],
        "pagination":
                  {
                    ...
                  }
    }
    

Lista Teste 

Lista Teste
/mensagens/{id}/lista_teste

Realiza o envio teste da mensagem para a Lista Teste.

  • Response  200
  • Body
        {
            "data": {
                        "OK": "OK"
                    }
        }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Não existem contatos válidos na Lista Teste."
                 }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Mensagem não encontrada."
                 }
    }
    
  • Response  500
  • Body
    {
        "error": {
                    "code":"04-ERRO-INTERNO",
                    "http_code":500,
                    "message":"Falha realizar o envio para a Lista Teste. Tente mais tarde."
                 }
    }            
    

Envios 

Envios da conta.

Visualizar 

Visualizar
/envios/{id}?{embeds}

Visualiza uma único envio.

  • Parameters
  • id
    string (required) Example: io4

    ID do envio

    embeds
    string (optional) Example: listas,mensagem

    Dados relacionados

    Choices: listas mensagem remetente

  • Response  200
  • Body
    {
      "data": {
        "id": "Lz",
        "codigo": "54",
        "status": "Concluído",
        "data_de_criacao": "2013-11-20 16:07:19.594479",
        "data_de_inicio": "2013-11-20 16:07:19.594479",
        "data_de_termino": null,
        "total_de_contatos": 430,
        "total_enviado": 0,
        "rejeitados": 0,
        "nao_rejeitados": 0,
        "descadastros": 0,
        "visualizacoes_totais": 0,
        "visualizacoes_unicas": 0,
        "cliques_totais": 0,
        "cliques_unicos": 0,
        "taxa_de_abertura": 0,
        "taxa_de_clique": 0,
        "taxa_de_rejeicao": 0,
        "remetente": "",
        "mensagem": {
          "data": [
            {
              "id": "LN",
              "contador": "85",
              "assunto": "testedasdsad",
              "html": "<html><head><\\/head><body>\\\r\\\n\\\t\\\t<p>\\\r\\\n\\\t\\\t\\\tteste<\\/p>\\\r\\\n\\\t\\\r\\\n<\\/body><\\/html>",
              "nome": "testes",
              "dataCadastro": "2013-10-15",
              "emailResposta": null,
              "mensagemDescadastro": "caso você deseje remover seu cadastro de nossa listas",
              "jaEnviada": true
            }
          ]
        },
        "listas": {
          "data": [
            {
              "id": "b",
              "nome": "gg",
              "ativo": true,
              "contatos_ativos": null
            },
            {
              "id": "T6",
              "nome": "NomeQualquer",
              "ativo": true,
              "contatos_ativos": null
            }
          ]
        },
        "porcentagem_de_conclusao": 0
      },
      "embeds": [
        "mensagem",
        "remetente",
        "listas"
      ]
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Registro não encontrado."
                 }
    }
    

Criar 

Criar
/envios

Cria um novo envio.

  • Parameters
  • mensagem
    string (required) Example: Tk

    ID da mensagem a ser enviada

    listas
    string (required) Example: 3l,3s

    Lista de IDs das listas

    data_de_inicio
    string (required) Example: 01/01/2015 21:10

    Data de início do envio, ou a palavra ‘agora’ para início imediato

    remetente
    string (optional) Example: Sf

    Remetente do envio

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "mensagem": "Tk",
        "listas": "Lk,3s,r4",
        "data_de_inicio": "agora",
    }
    
  • Response  200
  • Body
    {
      "data": {
        "id": "JW",
        "codigo": "1924",
        "id_mensagem": "TI",
        "status": "Em criação",
        "data_de_criacao": "2015-08-13 20:35:55.135908",
        "data_de_inicio": "2015-09-01 10:10:00",
        "data_de_termino": null,
        "total_de_contatos": 38150,
        "porcentagem_de_conclusao": "0.00"
      }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Parâmetro "x" não preenchido corretamente."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"A data/hora de agendamento escolhida pertence ao passado. Favor preencher com uma data futura ou a opção "agora" para iniciar o envio imediatamente."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Somente remetentes confirmados podem ser utilizados."
                 }
    } 
    
  • Response  401
  • Body
    {
        "error": {
                    "code":"03-NAO-AUTORIZADO",
                    "http_code":401,
                    "message":"O envio não pode exceder a quantidade de créditos que você possui. Reduza o número de destinatários ou adquira mais créditos e tente novamente."
                 }
    }
    

Buscar 

Buscar
/envios{?id,codigo,status}

Busca envios.

  • Parameters
  • id
    string (optional) Example: d12I4,-W

    Lista de ID(s) dos envios

    codigo
    string (optional) Example: 92

    Lista de códigos dos envios

    status
    string (optional) Example: 2,3

    Lista de códigos de status

    Choices: 0 (Suspenso) 1 (Enviando) 2 (Concluído) 3 (Cancelado) 4 (Agendado) 5 (Em criação)

  • Response  200
  • Body
    {
        "data": [
                    {
                        "id": "f",
                        "codigo": "11",
                        "id_mensagem": "L4",
                        "status": "Concluído",
                        "data_de_criacao": "2013-09-06 18:01:19.634969",
                        "data_de_inicio": "2013-09-06 18:01:19.634969",
                        "data_de_termino": null,
                        "total_de_contatos": 432,
                        "porcentagem_de_conclusao": "46.30"
                    },
                    ...
                ],
        "pagination":
                  {
                    ...
                  }
    }
    

Pausar 

Pausar
/envios/{id}/pausar

Pausa/suspende um envio.

  • Parameters
  • id
    string (required) Example: io4

    ID do envio

  • Response  200
  • Body
        {
            "data": {
                        "OK": "OK"
                    }
        }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Não é possível pausar o envio devido ao seu status atual."
                 }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Envio não encontrado."
                 }
    }
    

Cancelar 

Cancelar
/envios/{id}/cancelar

Cancela um envio.

  • Parameters
  • id
    string (required) Example: io4

    ID do envio

  • Response  200
  • Body
        {
            "data": {
                        "OK": "OK"
                    }
        }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Não é possível cancelar o envio devido ao seu status atual."
                 }
    }
    
  • Response  404
  • Body
    {
        "error": {
                    "code":"01-NAO-ENCONTRADO",
                    "http_code":404,
                    "message":"Envio não encontrado."
                 }
    }
    

Retomar/agendar 

Retomar/agendar
/envios/{id}/retomar

Retoma ou agenda um envio que está pausado ou agendado.

  • Parameters
  • id
    string (required) Example: io4

    ID do envio

    data
    string (required) Example: 01/01/2015 21:10

    Data de reinício do envio, ou a palavra ‘agora’ para reinício imediato

  • Request
  • Headers
    Content-Type: application/json
    Body
    {
        "data": "agora",
    }
    
  • Response  200
  • Body
    {
        "data": {
                    "OK": "OK"
                }
    }
    
  • Response  400
  • Body
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"A data/hora de agendamento escolhida pertence ao passado. Favor preencher com uma data futura ou a opção "agora" para iniciar o envio imediatamente."
                 }
    }
    
    ou
    
    {
        "error": {
                    "code":"02-ARGUMENTOS-INVALIDOS",
                    "http_code":400,
                    "message":"Não é possível cancelar o envio devido ao seu status atual."
                 }
    }            
    

Generated by aglio on 19 Aug 2015