Listar campanhas de e-mail

GET

/email-campaigns

const url = 'https://dattacrm.com.br/api/v1/email-campaigns?limit=50&state=draft';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dattacrm.com.br/api/v1/email-campaigns?limit=50&state=draft' \
  --header 'Authorization: Bearer <token>'

Lista as campanhas de e-mail da conta, da mais nova para a mais antiga, em páginas de até 50 itens, com HTML, público e horários. estimatedRecipients vem nulo na lista (contar o público de cada item pesaria demais): busque a campanha com get_email_campaign para obtê-lo. Use nextCursor no parâmetro cursor para buscar a página seguinte; quando vier nulo, acabou.

Authorizations

bearerAuth

Parameters

Query Parameters

cursor

Cursor da página anterior (nextCursor).

string

Cursor da página anterior (nextCursor).

limit

Itens por página (1 a 50, padrão 50). Menor que nas outras listas porque cada campanha traz o HTML inteiro.

integer

default: 50 >= 1 <= 50

Itens por página (1 a 50, padrão 50). Menor que nas outras listas porque cada campanha traz o HTML inteiro.

state

Filtra pela situação: draft, scheduled, running, paused, completed ou cancelled. Omitido traz todas.

string

Allowed values: draft scheduled running paused completed cancelled

Filtra pela situação: draft, scheduled, running, paused, completed ou cancelled. Omitido traz todas.

Responses

200

Sucesso.

application/json

object

data

required

Campanhas da página, da mais nova para a mais antiga.

Array<object>

Campanha de e-mail da conta.

object

required

Identificador da campanha.

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

Nome interno da campanha, como aparece no CRM.

string

subject

required

Assunto do e-mail.

string

preheader

required

Pré-cabeçalho: o texto curto que aparece depois do assunto na caixa de entrada.

string

html

required

Conteúdo HTML do e-mail, já sanitizado (sem scripts).

string

text

required

Versão em texto puro. Vazia: no envio, ela é gerada a partir do HTML.

string

state

required

Situação: draft (rascunho, editável pela API), scheduled (agendada na tela), running (enviando), paused (pausada), completed (concluída) ou cancelled (cancelada).

string

Allowed values: draft scheduled running paused completed cancelled

includeListIds

required

Listas cujos leads recebem a campanha.

Array<string>

excludeListIds

required

Listas cujos leads ficam de fora, mesmo que estejam numa lista ou tag incluída.

Array<string>

includeTags

required

Tags cujos leads recebem a campanha, combinadas com as listas incluídas conforme audienceMatch.

Array<string>

excludeTags

required

Tags cujos leads ficam de fora.

Array<string>

audienceMatch

required

Como as listas e tags incluídas se combinam: any (qualquer critério: está em alguma lista ou tem alguma tag) ou all (todos os critérios: está em todas as listas e tem todas as tags). As exclusões valem nos dois.

string

Allowed values: any all

audienceFilter

required

Filtros além de listas e tags; {} sem filtro. signup (cadastro): período from/to em AAAA-MM-DD no dia de São Paulo, utmField (source, medium, campaign, content ou term) com utmValue (sem diferenciar maiúsculas) e pageContains (trecho do endereço da página), tudo no mesmo cadastro. purchase (compra): mode bought (comprou) ou not_bought (não comprou), com productName e maxValue (valor da venda até, sem order bump) na mesma venda aprovada.

object

signup

Cadastro: entra quem tem um cadastro que atende a todos os campos preenchidos.

object

from

Primeiro dia (AAAA-MM-DD), inclusive.

string

Último dia (AAAA-MM-DD), inclusive.

string

utmField

Qual UTM do cadastro comparar.

string

Allowed values: source medium campaign content term

utmValue

Valor da UTM.

string

pageContains

Trecho do endereço da página do cadastro.

string

purchase

Compra: considera só vendas aprovadas, venda a venda.

object

mode

required

Bought (comprou) ou not_bought (não comprou).

string

Allowed values: bought not_bought

productName

Nome do produto, como chega do gateway.

string

maxValue

Valor da venda até (R$).

number

utm

required

UTMs aplicadas aos links do e-mail no envio.

object

enabled

required

Se as UTMs são acrescentadas aos links do e-mail.

boolean

source

required

Utm_source.

string

medium

required

Utm_medium.

string

campaign

required

Utm_campaign.

string

content

required

Utm_content.

string

term

required

Utm_term.

string

suggestedSendAt

required

Any of:

string
null

Data e hora em ISO 8601, com fuso.

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

scheduledAt

required

Any of:

string
null

Data e hora em ISO 8601, com fuso.

string format: date-time

createdAt

required

Quando a campanha foi criada.

string format: date-time

updatedAt

required

Última alteração da campanha.

string format: date-time

editUrl

required

Endereço da campanha no CRM, onde uma pessoa revisa, testa e agenda o envio; null quando o endereço público do CRM não está configurado.

string | null

estimatedRecipients

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

nextCursor

required

Cursor da próxima página; nulo na última página.

string | null

Example

{
  "data": [
    {
      "id": "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f",
      "state": "draft",
      "includeListIds": [
        "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f"
      ],
      "excludeListIds": [
        "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f"
      ],
      "audienceMatch": "any",
      "audienceFilter": {
        "signup": {
          "utmField": "source"
        },
        "purchase": {
          "mode": "bought"
        }
      },
      "suggestedSendAt": "2026-10-19T12:00:00.000Z",
      "scheduledAt": "2026-10-19T12:00:00.000Z",
      "createdAt": "2026-10-19T12:00:00.000Z",
      "updatedAt": "2026-10-19T12:00:00.000Z"
    }
  ]
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

X-RateLimit-Limit

integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining

integer

Requisições restantes na janela atual.

X-RateLimit-Reset

integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

400

Dados inválidos na requisição (validation_error), lead novo sem lista (list_required), campo que mudou de lugar (field_moved) ou chave enviada na URL (api_key_in_url).

application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

401

Chave ausente, inválida (invalid_api_key), vencida (api_key_expired) ou revogada (api_key_revoked).

application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

429

Limite de requisições atingido (rate_limited). Aguarde Retry-After segundos.

application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

X-RateLimit-Limit

integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining

integer

Requisições restantes na janela atual.

X-RateLimit-Reset

integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

Retry-After

integer

Segundos até poder tentar de novo.

500

Erro interno (internal_error). Informe o requestId ao suporte.

application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

Listar campanhas de e-mail

Authorizations

Parameters

Query Parameters

Responses

200

Example

Headers

400

Example generated

Headers

401

Example generated

Headers

429

Example generated

Headers

500

Example generated

Headers

Example ^generated

Example ^generated

Example ^generated

Example ^generated