Global values

Workspace-wide values reused in emails, automation steps and conditions as {{global.key}}.

Base URLhttps://api.emailit.com/v2Authentication Errors Rate limits

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

Create a global value

Creates a global value: one value for the whole workspace, used as {{global.<key>}} in templates, campaigns, automation emails and step settings, in conditions, and as a date to wait for. Requires an API key with the full scope. See Global values.

POST/global-values

Body parameters

keystringrequired

Starts with a lowercase letter and uses lowercase letters, digits and _, up to 64 characters. Unique in the workspace.

namestring

A display name, up to 191 characters.

typestringdefault: text

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

valuestring | number | boolean

The value, checked against the type: a number for number, true or false for boolean, YYYY-MM-DD for date, an ISO 8601 date and time for datetime (stored in UTC), and an http or https URL for url.

descriptionstring

A note for your team, up to 1000 characters.

Returns

Returns 201 with the global value in data. Returns 400 with errors when a field is invalid, 409 when the key is taken, and 422 when the workspace has 500 global values.

The global value object

objectstring

Always global_value.

idstring

The ID (gv_…).

keystring

The key, used as {{global.<key>}}.

namestring | null

A display name.

typestring

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

valuestring | number | boolean | null

The value: a number for number, true or false for boolean, and a string otherwise (YYYY-MM-DD for date, ISO 8601 in UTC for datetime).

descriptionstring | null

A note for your team.

created_atstring

When it was created.

updated_atstring

When it last changed.

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

Retrieve a global value

Returns one global value. Requires an API key with the full scope.

GET/global-values/{id}

Path parameters

idstringrequired

The ID (gv_…) or the key.

Returns

Returns the global value in data, or 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);

Update a global value

Changes a global value. Send only the fields to change. Requires an API key with the full scope.

Emails sent from then on use the new value, and so do automation runs that reach a Wait until step afterwards. Runs already waiting keep the date they read. Changing the key breaks {{global.<old key>}} in your templates.

POST/global-values/{id}

Path parameters

idstringrequired

The ID (gv_…) or the key.

Body parameters

keystring

A new key, unique in the workspace.

namestring | null

A display name.

typestring

A new type. The current value must fit it, or send a new value too.

valuestring | number | boolean | null

The new value, checked against the type. null clears it.

descriptionstring | null

A note for your team.

Returns

Returns the updated global value in data. Returns 400 when a field is invalid, 404 if it doesn’t exist, and 409 when the new key is taken.

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

List global values

Returns every global value of the workspace, sorted by key. A workspace has at most 500, so there’s no paging. Requires an API key with the full scope.

GET/global-values

Returns

dataobject[]

The global values.

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

Delete a global value

Deletes a global value. {{global.<key>}} then renders empty, conditions on it see no value, and Wait until steps that read it take their “date passed” path. Requires an API key with the full scope.

DELETE/global-values/{id}

Path parameters

idstringrequired

The ID (gv_…) or the key.

Returns

Returns { "message": "Global value was deleted." }, or 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);