Valores globais

Valores de todo o workspace reutilizados em e-mails, etapas e condições de automações como {{global.key}}.

URL basehttps://api.emailit.com/v2Autenticação Erros Limites de requisições

POST/global-values
GET/global-values/{id}
POST/global-values/{id}
GET/global-values
DEL/global-values/{id}

Criar um valor global

Cria um valor global: um valor único para todo o workspace, usado como {{global.<key>}} em templates, campanhas, e-mails e configurações de etapas de automações, em condições e como uma data pela qual esperar. Requer uma chave de API com escopo full. Consulte Valores globais.

POST/global-values

Parâmetros do corpo

keystringobrigatório

Começa com uma letra minúscula e usa letras minúsculas, dígitos e _, com até 64 caracteres. Única no workspace.

namestring

Um nome de exibição, com até 191 caracteres.

typestringpadrão: text

text, number, boolean, date, datetime ou url.

valuestring | number | boolean

O valor, verificado de acordo com o tipo: um número para number, true ou false para boolean, YYYY-MM-DD para date, uma data e um horário ISO 8601 para datetime (armazenados em UTC) e uma URL http ou https para url.

descriptionstring

Uma observação para a sua equipe, com até 1.000 caracteres.

Retorno

Retorna 201 com o valor global em data. Retorna 400 com errors quando um campo é inválido, 409 quando a chave já está em uso e 422 quando o workspace tem 500 valores globais.

O objeto de valor global

objectstring

Sempre global_value.

idstring

O ID (gv_…).

keystring

A chave, usada como {{global.<key>}}.

namestring | null

Um nome de exibição.

typestring

text, number, boolean, date, datetime ou url.

valuestring | number | boolean | null

O valor: um número para number, true ou false para boolean e uma string nos outros casos (YYYY-MM-DD para date, ISO 8601 em UTC para datetime).

descriptionstring | null

Uma observação para a sua equipe.

created_atstring

Quando ele foi criado.

updated_atstring

Quando ele foi alterado pela última vez.

POST/global-values

Terminal

curl -X POST https://api.emailit.com/v2/global-values \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key": "webinar_date", "name": "Webinar date", "type": "datetime", "value": "2026-11-05T17:00:00Z"}'

JavaScript

const res = await fetch('https://api.emailit.com/v2/global-values', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"key": "webinar_date", "name": "Webinar date", "type": "datetime", "value": "2026-11-05T17:00:00Z"}),
});
const result = await res.json();

Python

import os, requests

r = requests.post(
    "https://api.emailit.com/v2/global-values",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
    json={"key": "webinar_date", "name": "Webinar date", "type": "datetime", "value": "2026-11-05T17:00:00Z"},
)
result = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->post('global-values', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
    'json' => ['key' => 'webinar_date', 'name' => 'Webinar date', 'type' => 'datetime', 'value' => '2026-11-05T17:00:00Z'],
]);
$result = json_decode($response->getBody(), true);

Obter um valor global

Retorna um valor global. Requer uma chave de API com escopo full.

GET/global-values/{id}

Parâmetros de caminho

idstringobrigatório

O ID (gv_…) ou a chave.

Retorno

Retorna o valor global em data, ou 404.

GET/global-values/{id}

Terminal

curl https://api.emailit.com/v2/global-values/webinar_date \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JavaScript

const res = await fetch('https://api.emailit.com/v2/global-values/webinar_date', {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}` },
});
const result = await res.json();

Python

import os, requests

r = requests.get(
    "https://api.emailit.com/v2/global-values/webinar_date",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
)
result = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->get('global-values/webinar_date', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
]);
$result = json_decode($response->getBody(), true);

Atualizar um valor global

Altera um valor global. Envie apenas os campos a alterar. Requer uma chave de API com escopo full.

Os e-mails enviados a partir de então usam o novo valor, assim como as execuções de automações que chegarem a uma etapa Wait until depois disso. As execuções que já estão esperando mantêm a data que leram. Alterar a chave quebra {{global.<old key>}} nos seus templates.

POST/global-values/{id}

Parâmetros de caminho

idstringobrigatório

O ID (gv_…) ou a chave.

Parâmetros do corpo

keystring

Uma nova chave, única no workspace.

namestring | null

Um nome de exibição.

typestring

Um novo tipo. O valor atual deve ser compatível com ele, ou envie também um novo value.

valuestring | number | boolean | null

O novo valor, verificado de acordo com o tipo. null o limpa.

descriptionstring | null

Uma observação para a sua equipe.

Retorno

Retorna o valor global atualizado em data. Retorna 400 quando um campo é inválido, 404 se ele não existir e 409 quando a nova chave já está em uso.

POST/global-values/{id}

Terminal

curl -X POST https://api.emailit.com/v2/global-values/webinar_date \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value": "2026-12-03T17:00:00Z"}'

JavaScript

const res = await fetch('https://api.emailit.com/v2/global-values/webinar_date', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"value": "2026-12-03T17:00:00Z"}),
});
const result = await res.json();

Python

import os, requests

r = requests.post(
    "https://api.emailit.com/v2/global-values/webinar_date",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
    json={"value": "2026-12-03T17:00:00Z"},
)
result = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->post('global-values/webinar_date', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
    'json' => ['value' => '2026-12-03T17:00:00Z'],
]);
$result = json_decode($response->getBody(), true);

Listar valores globais

Retorna todos os valores globais do workspace, ordenados pela chave. Um workspace tem no máximo 500, então não há paginação. Requer uma chave de API com escopo full.

GET/global-values

Retorno

dataobject[]

Os valores globais.

GET/global-values

Terminal

curl https://api.emailit.com/v2/global-values \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JavaScript

const res = await fetch('https://api.emailit.com/v2/global-values', {
  method: 'GET',
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}` },
});
const result = await res.json();

Python

import os, requests

r = requests.get(
    "https://api.emailit.com/v2/global-values",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
)
result = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->get('global-values', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
]);
$result = json_decode($response->getBody(), true);

Excluir um valor global

Exclui um valor global. A partir daí, {{global.<key>}} é renderizado vazio, as condições sobre ele não veem nenhum valor, e as etapas Wait until que o leem seguem o caminho de “data já passou”. Requer uma chave de API com escopo full.

DELETE/global-values/{id}

Parâmetros de caminho

idstringobrigatório

O ID (gv_…) ou a chave.

Retorno

Retorna { "message": "Global value was deleted." }, ou 404.

DELETE/global-values/{id}

Terminal

curl -X DELETE https://api.emailit.com/v2/global-values/seats \
  -H "Authorization: Bearer $EMAILIT_API_KEY"

JavaScript

const res = await fetch('https://api.emailit.com/v2/global-values/seats', {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.EMAILIT_API_KEY}` },
});
const result = await res.json();

Python

import os, requests

r = requests.delete(
    "https://api.emailit.com/v2/global-values/seats",
    headers={"Authorization": f"Bearer {os.environ['EMAILIT_API_KEY']}"},
)
result = r.json()

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://api.emailit.com/v2/']);

$response = $client->delete('global-values/seats', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('EMAILIT_API_KEY')],
]);
$result = json_decode($response->getBody(), true);