Back to top

Criaenvio API v1

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
GET/contatos/{id}{?embeds}

Visualiza um único contato.

Example URI

GET https://api.criaenvio.com/v1/contatos/ioddw4?embeds=grupos
URI Parameters
HideShow
id
string (required) Example: ioddw4

ID do contato

embeds
string (optional) Example: grupos

Dados relacionados

Choices: grupos campos

Response  200
HideShow
Body
{
    "data": {
                "id": "idasd",
                "nome": "Editado",
                "email": "[email protected]",
                "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": "[email protected]",
                "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": "[email protected]",
                "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 segmentação",
                                    "ativo": true,
                                    "contatos_ativos": "3212"
                                },
                                {
                                    "id": "iZip",
                                    "nome": "Nome de Outra segmentação",
                                    "ativo": true,
                                    "contatos_ativos": "1530"
                                },
                            ],
                            "pagination":
                                          {
                                            ...
                                          }
                          }
    }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}
Response  500
HideShow
Body
{
  "error": {
    "code": "04-ERRO-INTERNO",
    "http_code": 500,
    "message": "Internal Error"
  }
}

Atualizar
PUT/contatos/{id}{?embeds}

Atualiza um contato.

Example URI

PUT https://api.criaenvio.com/v1/contatos/ioddw4?embeds=grupos
URI Parameters
HideShow
id
string (required) Example: ioddw4

ID do contato

embeds
string (optional) Example: grupos

Dados relacionados

Choices: grupos campos

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "nome": "novo nome para contato",
  "sexo": "m",
  "data_de_nascimento": "02/02/2012"
}
Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}
Response  400
HideShow
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
POST/contatos

Cria um novo contato.

Example URI

POST https://api.criaenvio.com/v1/contatos
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "nome": "novo contato",
  "email": "[email protected]",
  "sexo": "f",
  "data_de_nascimento": "02/02/2012"
}
Response  200
HideShow
Body
{
  "data": {
    "id": "Fssd12",
    "nome": "novo contato",
    "email": "[email protected]",
    "sexo": "f",
    "data_de_nascimento": "02/02/2012"
  }
}
Response  400
HideShow
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
GET/contatos{?id,nome,email,sexo,idadeinicio,idadetermino,datadecadastroinicio,datadecadastrotermino,datadenascimentoinicio,datadenascimentotermino,aniversarioinicio,aniversariotermino,status,qualidade,campo}

Busca contatos.

Example URI

GET https://api.criaenvio.com/v1/contatos?id=io4,sd0&nome=Campo de teste&email=@yahoo.com&sexo=m&idadeinicio=18&idadetermino=70&datadecadastroinicio=10/01/2010&datadecadastrotermino=10/01/2014&datadenascimentoinicio=10/01/1986&datadenascimentotermino=10/01/1999&aniversarioinicio=31/01&aniversariotermino=31/01&status=todos&qualidade=5,6,7&campo=valor do campo
URI Parameters
HideShow
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
HideShow
Body
{
    "data": [
                {
                    "id":"k",
                    "nome":"Editado",
                    "email":"[email protected]",
                    "qualidade":"2",
                    "ativo":true,
                    "descadastrado":false,
                    "sexo":"m",
                    "dataNascimento":"2012-02-02",
                    "dataCadastro":"2013-01-20 09:27:05"
                },
                {
                    "id":"E",
                    "nome":"",
                    "email":"[email protected]",
                    "qualidade":"5",
                    "ativo":true,
                    "descadastrado":false,
                    "sexo":null,
                    "dataNascimento":null,
                    "dataCadastro":"2014-02-18 18:58:10"
                }
            ],
    "pagination":
              {
                ...
              }
}

Ativar

Ativar
PUT/contatos/{id}/ativar

Ativa um contato.

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

Example URI

PUT https://api.criaenvio.com/v1/contatos/io4/ativar
URI Parameters
HideShow
id
string (required) Example: io4

ID do contato

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

Desativar

Desativar
PUT/contatos/{id}/desativar

Desativa um contato.

Example URI

PUT https://api.criaenvio.com/v1/contatos/io4/desativar
URI Parameters
HideShow
id
string (required) Example: io4

ID do contato

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

Inscrever em segmentação

Inscrever em segmentação
POST/contatos/{id}/inscrever

Inscreve o contato em uma ou mais segmentações.

Example URI

POST https://api.criaenvio.com/v1/contatos/io4/inscrever
URI Parameters
HideShow
id
string (required) Example: io4

ID do contato

Request
HideShow
Headers
Content-Type: application/json
Body
{
    "idGrupos": "io4, lis2, jj",
}
Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}
Response  400
HideShow
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 segmentação

Desiscrever de segmentação
POST/contatos/{id}/desinscrever

Desinscreve o contato de uma ou mais segmentações.

Example URI

POST https://api.criaenvio.com/v1/contatos/io4/desinscrever
URI Parameters
HideShow
id
string (required) Example: io4

ID do contato

Request
HideShow
Headers
Content-Type: application/json
Body
{
    "idGrupos": "io4, lis2, jj",
}
Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}
Response  400
HideShow
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
PUT/contatos/{id}/campos

Atualiza os campos personalizados do contato.

Example URI

PUT https://api.criaenvio.com/v1/contatos/io4/campos
URI Parameters
HideShow
id
string (required) Example: io4

ID do contato

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "campos": {
    "iof": "valor para o campo",
    "io4k": "outro valor"
  }
}
Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}
Response  400
HideShow
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."
             }
}

Segmentações

Conjunto de contatos.

Segmentação

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

Visualiza uma única segmentação.

Example URI

GET https://api.criaenvio.com/v1/grupos/io4?contatos&todos
URI Parameters
HideShow
id
string (required) Example: io4

ID da segmentação

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
HideShow
Body
{
    "data": {
                "id": "io4",
                "nome": "Nome da segmentação",
                "ativo": true,
                "contatos_ativos": "22"
            }
}

ou

{
    "data": {
                "id": "io4",
                "nome": "Nome da segmentação",
                "ativo": true,
                "contatos_ativos": "22",
                "contatos": {
                            "data": [
                                {
                                    "id":"k",
                                    "nome":"Editado",
                                    "email":"[email protected]",
                                    "qualidade":"2",
                                    "ativo":true,
                                    "descadastrado":false,
                                    "sexo":"m",
                                    "dataNascimento":"2012-02-02",
                                    "dataCadastro":"2013-01-20 09:27:05"
                                },
                                {
                                    "id":"E",
                                    "nome":"",
                                    "email":"[email protected]",
                                    "qualidade":"5",
                                    "ativo":true,
                                    "descadastrado":false,
                                    "sexo":null,
                                    "dataNascimento":null,
                                    "dataCadastro":"2014-02-18 18:58:10"
                                }
                                ],
                                "pagination":
                                    {
                                        ...
                                    }
                            }
            }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}

Atualizar
PUT/grupos/{id}?{embeds,status}

Atualiza uma segmentação.

Example URI

PUT https://api.criaenvio.com/v1/grupos/io4?contatos&todos
URI Parameters
HideShow
id
string (required) Example: io4

ID da segmentação

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
HideShow
Headers
Content-Type: application/json
Body
{
  "nome": "Novo nome da segmentação"
}
Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}
Response  400
HideShow
Body
{
  "error": {
    "code": "02-ARGUMENTOS-INVALIDOS",
    "http_code": 404,
    "message": "Erro ao processar requisição. Detalhe(s): ..."
  }
}

Criar

Criar
POST/grupos

Cria uma nova segmentação.

Example URI

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

Buscar

Buscar
GET/grupos{?id,nome,ativo}

Busca segmentações.

Example URI

GET https://api.criaenvio.com/v1/grupos?id=io4,sd0&nome=Campo de teste&ativo=true
URI Parameters
HideShow
id
string (optional) Example: io4,sd0

Lista de IDs de segmentações, separados por vírgula

nome
string (optional) Example: Campo de teste

Nome da segmentação

ativo
string (optional) Default: true Example: true

Status da segmentação

Choices: true false

Response  200
HideShow
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
PUT/grupos/ativar?{id}

Ativa uma ou mais segmentações.

Example URI

PUT https://api.criaenvio.com/v1/grupos/ativar?io4,sd0
URI Parameters
HideShow
id
string (required) Example: io4,sd0

Lista de IDs de segmentações, separados por vírgula

Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  400
HideShow
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
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}

Desativar

Desativar
PUT/grupos/desativar?{id}

Desativa uma ou mais segmentações.

Example URI

PUT https://api.criaenvio.com/v1/grupos/desativar?io4,sd0
URI Parameters
HideShow
id
string (required) Example: io4,sd0

Lista de IDs de segmentações, separados por vírgula

Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  400
HideShow
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
HideShow
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
GET/campos/{id}

Visualiza um único campo personalizado.

Example URI

GET https://api.criaenvio.com/v1/campos/d12I4
URI Parameters
HideShow
id
string (required) Example: d12I4

ID do campo personalizado

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

Atualizar
PUT/campos/{id}

Atualiza um campo personalizado.

Example URI

PUT https://api.criaenvio.com/v1/campos/d12I4
URI Parameters
HideShow
id
string (required) Example: d12I4

ID do campo personalizado

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "nome": "Novo nome do campo personalizado"
}
Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  404
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Campo personalizado não encontrado."
  }
}
Response  400
HideShow
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
DELETE/campos/{id}

Remove um campo personalizado.

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

Example URI

DELETE https://api.criaenvio.com/v1/campos/d12I4
URI Parameters
HideShow
id
string (required) Example: d12I4

ID do campo personalizado

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

Criar

Criar
POST/campos

Cria um novo campo personalizado.

Example URI

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

Buscar

Buscar
GET/campos{?id,nome}

Busca campos personalizados.

Example URI

GET https://api.criaenvio.com/v1/campos?id=d12I4&nome=Campo de teste
URI Parameters
HideShow
id
string (optional) Example: d12I4

ID do campo personalizado

nome
string (optional) Example: Campo de teste

Nome do campo personalizado

Response  200
HideShow
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
GET/remetentes{?id,nome,email}

Busca remetentes.

Example URI

GET https://api.criaenvio.com/v1/remetentes?id=d12I4&nome=Nome da Conta&email=[email protected]
URI Parameters
HideShow
id
string (optional) Example: d12I4

ID do remetente

nome
string (optional) Example: Nome da Conta

Nome do remetente

email
string (optional) Example: [email protected]

E-mail do remetente

Response  200
HideShow
Body
{
    "data": [
                {
                    "id": "Eo",
                    "nome": "Nome do remetente",
                    "email": "[email protected]",
                    "principal": true,
                    "confirmado": true
                },
                {
                    "id": "Xo",
                    "nome": "Nome do remetente 2",
                    "email": "[email protected]",
                    "principal": false,
                    "confirmado": true
                }
            ],
    "pagination":
              {
                ...
              }
}

Mensagens

Mensagens da conta.

Mensagem

Visualizar
GET/mensagens/{id}

Visualiza uma única mensagem.

Example URI

GET https://api.criaenvio.com/v1/mensagens/sd
URI Parameters
HideShow
id
string (required) Example: sd

ID da mensagem

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

Atualizar
PUT/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.

Example URI

PUT https://api.criaenvio.com/v1/mensagens/-j
URI Parameters
HideShow
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 protected]

E-mail de resposta da mensagem

mensagem_descadastro
string (optional) Example: Quer sair?

Mensagem localizada antes do link de cancelamento

Request
HideShow
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 protected]",
  "mensagem_descadastro": "Deseja sair da lista? Clique ao lado"
}
Response  200
HideShow
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 protected]",
      "mensagemDescadastro": "Deseja sair da lista? Clique ao lado",
      "jaEnviada": false
    }
  }
}
Response  400
HideShow
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
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Mensagem não encontrada."
  }
}
Response  500
HideShow
Body
{
  "error": {
    "code": "04-ERRO-INTERNO",
    "http_code": 500,
    "message": "Falha ao calcular o tamanho da mensagem. Tente mais tarde."
  }
}

Remover
DELETE/mensagens/{id}

Remove uma mensagem.

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

Example URI

DELETE https://api.criaenvio.com/v1/mensagens/sd
URI Parameters
HideShow
id
string (required) Example: sd

ID da mensagem

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

Criar

Criar
POST/mensagens

Cria uma nova mensagem.

Example URI

POST https://api.criaenvio.com/v1/mensagens
URI Parameters
HideShow
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 protected]

E-mail de resposta da mensagem

mensagem_descadastro
string (optional) Example: Quer sair?

Mensagem localizada antes do link de cancelamento

Request
HideShow
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 protected]",
  "mensagem_descadastro": "Deseja sair da lista? Clique ao lado"
}
Response  200
HideShow
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 protected]",
    "mensagemDescadastro": "Deseja sair da lista? Clique ao lado",
    "jaEnviada": false
  }
}
Response  400
HideShow
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
HideShow
Body
{
  "error": {
    "code": "04-ERRO-INTERNO",
    "http_code": 500,
    "message": "Falha ao calcular o tamanho da mensagem. Tente mais tarde."
  }
}

Buscar

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

Busca mensagens.

Example URI

GET https://api.criaenvio.com/v1/mensagens?id=d12I4,-W&assunto=Dia das mães&nome=Nome exemplo&contador=92&datadecadastroinicio=10/01/2010&datadecadastrotermino=10/01/2015
URI Parameters
HideShow
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
HideShow
Body
{
    "data": [
                {
                    "assunto": "Novo teste",
                    "contador": "22",
                    "dataCadastro": "2015-02-02",
                    "emailResposta": "[email protected]",
                    "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 protected]",
                    "id": "-W",
                    "jaEnviada": false,
                    "mensagemDescadastro": "caso queira sair da lista",
                    "nome": null
                }
            ],
    "pagination":
              {
                ...
              }
}

Lista Teste

Lista Teste
GET/mensagens/lista_teste

Realiza o envio teste da mensagem para a Lista Teste.

Example URI

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

Campanhas

Campanhas da conta.

Visualizar

Visualizar
GET/envios/{id}?{embeds}

Visualiza uma única campanha.

Example URI

GET https://api.criaenvio.com/v1/envios/io4?listas,mensagem
URI Parameters
HideShow
id
string (required) Example: io4

ID da campanha

embeds
string (optional) Example: listas,mensagem

Dados relacionados

Choices: listas mensagem remetente

Response  200
HideShow
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
HideShow
Body
{
  "error": {
    "code": "01-NAO-ENCONTRADO",
    "http_code": 404,
    "message": "Registro não encontrado."
  }
}

Criar

Criar
POST/envios

Cria uma nova campanha.

Example URI

POST https://api.criaenvio.com/v1/envios
URI Parameters
HideShow
mensagem
string (required) Example: Tk

ID da mensagem a ser enviada

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

Lista de IDs das segmentações

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

Data de início da campanha, ou a palavra ‘agora’ para início imediato

remetente
string (optional) Example: Sf

Remetente da campanha

Request
HideShow
Headers
Content-Type: application/json
Body
{
    "mensagem": "Tk",
    "listas": "Lk,3s,r4",
    "data_de_inicio": "agora",
}
Response  200
HideShow
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
HideShow
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
HideShow
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
GET/envios{?id,codigo,status}

Busca campanhas.

Example URI

GET https://api.criaenvio.com/v1/envios?id=d12I4,-W&codigo=92&status=2,3
URI Parameters
HideShow
id
string (optional) Example: d12I4,-W

Lista de ID(s) das campanhas

codigo
string (optional) Example: 92

Lista de códigos das campanhas

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
HideShow
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
GET/envios/{id}/pausar

Pausa/suspende uma campanha.

Example URI

GET https://api.criaenvio.com/v1/envios/io4/pausar
URI Parameters
HideShow
id
string (required) Example: io4

ID da campanha

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

Cancelar

Cancelar
GET/envios/{id}/cancelar

Cancela uma campanha.

Example URI

GET https://api.criaenvio.com/v1/envios/io4/cancelar
URI Parameters
HideShow
id
string (required) Example: io4

ID da campanha

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

Retomar/agendar

Retomar/agendar
POST/envios/{id}/retomar

Retoma ou agenda uma campanha que está pausado ou agendado.

Example URI

POST https://api.criaenvio.com/v1/envios/io4/retomar
URI Parameters
HideShow
id
string (required) Example: io4

ID da campanha

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

Data de reinício da campanha, ou a palavra ‘agora’ para reinício imediato

Request
HideShow
Headers
Content-Type: application/json
Body
{
    "data": "agora",
}
Response  200
HideShow
Body
{
  "data": {
    "OK": "OK"
  }
}
Response  400
HideShow
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 02 May 2024