# Valores globais API

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

URL base: `https://api.emailit.com/v2`. Autentique-se com `Authorization: Bearer <API key>`.

## Criar um valor global — POST /global-values

> Crie um valor de todo o workspace, como a data de um webinar ou um link de agendamento, usado como {{global.key}} em e-mails, etapas e condições de automações.

# 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](/pt/docs/contacts/global-values/).

`POST /global-values`

## Parâmetros do corpo

- `key` (string, obrigatório): Começa com uma letra minúscula e usa letras minúsculas, dígitos e `_`, com até 64 caracteres. Única no workspace.

- `name` (string): Um nome de exibição, com até 191 caracteres.

- `type` (string): `text`, `number`, `boolean`, `date`, `datetime` ou `url`.

- `value` (string | 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`.

- `description` (string): Uma observação para a sua equipe, com até 1.000 caracteres.

## Retorno

Retorna `201` com o [valor global](#the-global-value-object) 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.

**Requisição** `POST /global-values`

**cURL**

```bash
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"}'
```

**Node.js**

```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**

```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**

```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);
```

## O objeto de valor global

- `object` (string): Sempre `global_value`.

- `id` (string): O ID (`gv_…`).

- `key` (string): A chave, usada como `{{global.<key>}}`.

- `name` (string | null): Um nome de exibição.

- `type` (string): `text`, `number`, `boolean`, `date`, `datetime` ou `url`.

- `value` (string | 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`).

- `description` (string | null): Uma observação para a sua equipe.

- `created_at` (string): Quando ele foi criado.

- `updated_at` (string): Quando ele foi alterado pela última vez.

---
Fonte: https://emailit.com/pt/docs/api-reference/global-values/create/

## Obter um valor global — GET /global-values/{id}

> Obtenha um valor global pelo ID ou pela chave.

# Obter um valor global

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

`GET /global-values/{id}`

## Parâmetros de caminho

- `id` (string, obrigatório): O ID (`gv_…`) ou a chave.

## Retorno

Retorna o [valor global](/pt/docs/api-reference/global-values/create/#the-global-value-object) em `data`, ou `404`.

**Requisição** `GET /global-values/{id}`

**cURL**

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

**Node.js**

```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**

```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**

```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);
```

---
Fonte: https://emailit.com/pt/docs/api-reference/global-values/get/

## Atualizar um valor global — POST /global-values/{id}

> Altere o valor, a chave, o nome, o tipo ou a descrição de um valor global. Os e-mails enviados a partir de então usam o novo valor.

# 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

- `id` (string, obrigatório): O ID (`gv_…`) ou a chave.

## Parâmetros do corpo

- `key` (string): Uma nova chave, única no workspace.

- `name` (string | null): Um nome de exibição.

- `type` (string): Um novo tipo. O valor atual deve ser compatível com ele, ou envie também um novo `value`.

- `value` (string | number | boolean | null): O novo valor, verificado de acordo com o tipo. `null` o limpa.

- `description` (string | null): Uma observação para a sua equipe.

## Retorno

Retorna o [valor global](/pt/docs/api-reference/global-values/create/#the-global-value-object) 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.

**Requisição** `POST /global-values/{id}`

**cURL**

```bash
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"}'
```

**Node.js**

```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**

```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**

```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);
```

---
Fonte: https://emailit.com/pt/docs/api-reference/global-values/update/

## Listar valores globais — GET /global-values

> Liste todos os valores globais do workspace, ordenados pela chave.

# 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

- `data` (object[]): Os [valores globais](/pt/docs/api-reference/global-values/create/#the-global-value-object).

**Requisição** `GET /global-values`

**cURL**

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

**Node.js**

```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**

```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**

```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);
```

---
Fonte: https://emailit.com/pt/docs/api-reference/global-values/list/

## Excluir um valor global — DELETE /global-values/{id}

> Exclua um valor global. Os templates que o usam o renderizam vazio.

# 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

- `id` (string, obrigatório): O ID (`gv_…`) ou a chave.

## Retorno

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

**Requisição** `DELETE /global-values/{id}`

**cURL**

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

**Node.js**

```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**

```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**

```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);
```

---
Fonte: https://emailit.com/pt/docs/api-reference/global-values/delete/