Valeurs globales

Valeurs communes à tout l’espace de travail, réutilisées dans les e-mails, les étapes et les conditions d’automatisation sous la forme {{global.key}}.

URL de basehttps://api.emailit.com/v2Authentification Erreurs Limites de débit

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

Créer une valeur globale

Crée une valeur globale : une valeur unique pour tout l’espace de travail, utilisée sous la forme {{global.<key>}} dans les modèles, les campagnes, les e-mails et les paramètres d’étape des automatisations, dans les conditions, et comme date à attendre. Nécessite une clé API de portée full. Consultez Valeurs globales.

POST/global-values

Paramètres du corps

keystringobligatoire

Commence par une lettre minuscule et ne contient que des lettres minuscules, des chiffres et _, 64 caractères au maximum. Unique dans l’espace de travail.

namestring

Un nom d’affichage, 191 caractères au maximum.

typestringpar défaut : text

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

valuestring | number | boolean

La valeur, vérifiée selon le type : un nombre pour number, true ou false pour boolean, YYYY-MM-DD pour date, une date et une heure au format ISO 8601 pour datetime (enregistrées en UTC), et une URL http ou https pour url.

descriptionstring

Une note pour votre équipe, 1 000 caractères au maximum.

Réponse

Renvoie 201 avec la valeur globale dans data. Renvoie 400 avec errors quand un champ n’est pas valide, 409 quand la clé est déjà prise, et 422 quand l’espace de travail a déjà 500 valeurs globales.

Objet valeur globale

objectstring

Toujours global_value.

idstring

L’ID (gv_…).

keystring

La clé, utilisée sous la forme {{global.<key>}}.

namestring | null

Un nom d’affichage.

typestring

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

valuestring | number | boolean | null

La valeur : un nombre pour number, true ou false pour boolean, et une chaîne sinon (YYYY-MM-DD pour date, ISO 8601 en UTC pour datetime).

descriptionstring | null

Une note pour votre équipe.

created_atstring

Date de création.

updated_atstring

Date de la dernière modification.

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

Récupérer une valeur globale

Renvoie une valeur globale. Nécessite une clé API de portée full.

GET/global-values/{id}

Paramètres de chemin

idstringobligatoire

L’ID (gv_…) ou la clé.

Réponse

Renvoie la valeur globale dans 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);

Mettre à jour une valeur globale

Modifie une valeur globale. Transmettez uniquement les champs à modifier. Nécessite une clé API de portée full.

Les e-mails envoyés ensuite utilisent la nouvelle valeur, de même que les exécutions d’automatisation qui atteignent une étape Wait until après la modification. Les exécutions déjà en attente conservent la date qu’elles ont lue. Changer la clé casse {{global.<old key>}} dans vos modèles.

POST/global-values/{id}

Paramètres de chemin

idstringobligatoire

L’ID (gv_…) ou la clé.

Paramètres du corps

keystring

Une nouvelle clé, unique dans l’espace de travail.

namestring | null

Un nom d’affichage.

typestring

Un nouveau type. La valeur actuelle doit lui correspondre ; sinon, transmettez aussi une nouvelle value.

valuestring | number | boolean | null

La nouvelle valeur, vérifiée selon le type. null l’efface.

descriptionstring | null

Une note pour votre équipe.

Réponse

Renvoie la valeur globale mise à jour dans data. Renvoie 400 quand un champ n’est pas valide, 404 si elle n’existe pas, et 409 quand la nouvelle clé est déjà prise.

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

Lister les valeurs globales

Renvoie toutes les valeurs globales de l’espace de travail, triées par clé. Un espace de travail en compte 500 au maximum : il n’y a donc pas de pagination. Nécessite une clé API de portée full.

GET/global-values

Réponse

dataobject[]

Les valeurs globales.

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

Supprimer une valeur globale

Supprime une valeur globale. {{global.<key>}} est ensuite rendu vide, les conditions qui la vérifient ne trouvent aucune valeur, et les étapes Wait until qui la lisent prennent leur chemin « date passée ». Nécessite une clé API de portée full.

DELETE/global-values/{id}

Paramètres de chemin

idstringobligatoire

L’ID (gv_…) ou la clé.

Réponse

Renvoie { "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);