AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Count audiences, manage campaigns, retrieve statistics and access invoices from your own tools.
https://api.dmseurope.com/v1/Create a key under My account → API, store it in your server-side secret manager and use it only for server-to-server exchanges.
Every request requires Bearer authentication. Accept-Language accepts fr, en, es or it and controls translated error messages.
Authorization: Bearer API_KEY
Accept-Language: enDefault limits per account and IP: 120 reads, 20 mutations (excluding exclusion-list PATCH) and 20 audience counts per minute. PATCH /exclusion-lists/{list_id} uses the exclusion_import quota of 120 calls/minute, including renaming and import cancellation. On HTTP 429, follow Retry-After.
Open a route to see every accepted parameter, a complete request, the exact success response structure and its possible errors.
/audiences/countCount an audienceReturns current aggregate volumes without saving an audience.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
Content-TypestringRequiredRequired JSON media type for the request body.
channelenumRequiredCampaign product used for the count.
emailEmail onlysmsSMS onlyemail_smsEmail and SMS at their scheduled datesemail_retargeting_smsEmail followed by SMS retargetingtargetingobjectRequiredNested JSON object.
countriesarrayRequiredSelected countries: FR France, GB United Kingdom, ES Spain, IT Italy.
FRFranceGBUnited KingdomESSpainITItalygeographyobjectRequiredGeographic criteria grouped by selected country.
{country}objectRequiredNested JSON object.
regionsarrayOptionalRegion IDs returned by GET /targeting/geography with type=region.
departmentsarrayOptionalDepartment or administrative-area IDs returned by GET /targeting/geography with type=department.
citiesarrayOptionalCity IDs returned by GET /targeting/geography with type=city. City results include their region and department to distinguish duplicate names.
postal_codesarrayOptionalPostal codes available for the country.
radius_kmintegerOptionalOptional straight-line radius from 1 to 200 km, applied to every selected city and postcode. At least one city or postcode is required; regions and departments then only help disambiguate the selected origins.
profileobjectRequiredDemographic and household criteria; use an empty object for no filter.
age_minintegerOptionalMinimum inclusive age.
age_maxintegerOptionalMaximum inclusive age.
gender_idsarrayOptionalChoose one or more gender IDs shown below. An empty array includes all genders.
1maleMale2femaleFemale3unknownUnknowncsp_idsarrayOptionalChoose one or more socio-professional category IDs shown below. An empty array includes every category.
6csp_plusHigher socioeconomic group7csp_middleMiddle socioeconomic group8csp_minusLower socioeconomic group9unknownUnknownhousing_status_idsarrayOptionalChoose one or more housing-status IDs shown below. An empty array includes every status.
10ownerOwner11tenantTenant12otherOther status4unknownUnknownhousing_type_idsarrayOptionalChoose one or more housing-type IDs shown below. An empty array includes every type.
14houseHouse15apartmentApartment16otherOther housing type5unknownUnknowncar_owner_status_idsarrayOptionalChoose the car-owner ID shown below to target vehicle owners. An empty array applies no car-ownership filter.
18ownerOwns a vehicle19non_ownerDoes not own a vehicle20unknownUnknownexclusionsobjectRequiredRecent-contact and previous-campaign exclusions.
recent_daysenumOptional0 applies no recent-contact exclusion; 15, 30 or 60 excludes contacts already reached during that many previous days.
0No recent-contact exclusion15Exclude contacts reached in the last 15 days30Exclude contacts reached in the last 30 days60Exclude contacts reached in the last 60 dayscampaign_referencesarrayOptionalExclude contacts from sent campaigns owned by the account during the last 12 months.
list_idsarrayOptionalAt most two lists: one email and one telephone. Active, published, unexpired lists owned by the account. A matching email or telephone excludes the entire contact across channels. Versions are pinned for the campaign.
https://api.dmseurope.com/v1/audiences/countcurl -X POST 'https://api.dmseurope.com/v1/audiences/count' \
-H 'Authorization: Bearer API_KEY' -H 'Content-Type: application/json' \
-d '{"channel":"email","targeting":{"countries":["FR"],"geography":{"FR":{"regions":[11],"departments":[75],"cities":[],"postal_codes":["75001"],"radius_km":20}},"profile":{"age_min":30,"age_max":55,"gender_ids":[1],"csp_ids":[],"housing_status_ids":[],"housing_type_ids":[],"car_owner_status_ids":[]},"exclusions":{"recent_days":30,"campaign_references":[]}}}'<?php
$url = 'https://api.dmseurope.com/v1/audiences/count';
$payload = <<<'JSON'
{
"channel": "email",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
}
}
JSON;
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/audiences/count', {
method: 'POST',
headers: {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"channel": "email",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
}
})
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/audiences\/count"
headers = {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
}
payload = json.loads(r'''
{
"channel": "email",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
}
}
''')
response = requests.request("POST", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
A targeting value is unknown or unavailable.
The JSON body exceeds the permitted size.
Content-Type must be application/json.
/targeting/geographyFind geographic identifiersReturns the region, department or city identifiers accepted by targeting.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
countryenumRequiredCountry whose geographic reference is queried.
FRFranceGBUnited KingdomESSpainITItalytypeenumRequiredReference level to return: regions, departments or cities.
regionRegiondepartmentDepartment or administrative areacityCityquerystringConditionalOptional for regions and departments. Required for cities, with at least 2 characters.
https://api.dmseurope.com/v1/targeting/geographycurl 'https://api.dmseurope.com/v1/targeting/geography?country=FR&type=city&query=Paris' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/targeting/geography?country=FR&type=city&query=Paris';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/targeting/geography?country=FR&type=city&query=Paris', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/targeting\/geography?country=FR&type=city&query=Paris"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
/campaignsList campaignsReturns the account’s campaigns with pagination and filters.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
pageintegerOptionalRequested page number.
per_pageintegerOptionalNumber of results per page.
statusenumOptionalExact campaign status.
draftDraftpending_validationPending reviewneeds_changesCorrections requiredscheduledScheduledsendingSendingsentSentcancelledCancelledproductenumOptionalCampaign product filter.
emailEmail onlysmsSMS onlyemail_smsEmail and SMS at their scheduled datesemail_retargeting_smsEmail followed by SMS retargetingcountryenumOptionalCountry filter.
FRFranceGBUnited KingdomESSpainITItalycreated_fromstringOptionalInclusive minimum creation date.
created_tostringOptionalInclusive maximum creation date.
scheduled_fromstringOptionalInclusive minimum scheduled date.
scheduled_tostringOptionalInclusive maximum scheduled date.
searchstringOptionalCampaign name or public reference search.
https://api.dmseurope.com/v1/campaignscurl 'https://api.dmseurope.com/v1/campaigns?page=1&per_page=20&status=scheduled&country=FR' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/campaigns?page=1&per_page=20&status=scheduled&country=FR';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/campaigns?page=1&per_page=20&status=scheduled&country=FR', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/campaigns?page=1&per_page=20&status=scheduled&country=FR"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
/campaignsCreate a campaignCounts the audience, calculates the price, reserves credit and submits a complete campaign.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
Content-TypestringRequiredRequired JSON media type for the request body.
Client-ReferencestringRequiredPermanent business reference unique to this campaign creation. A second creation with the same value is rejected.
namestringRequiredCampaign name.
productenumRequiredemail: email only; sms: SMS only; email_sms: both channels; email_retargeting_sms: email followed by SMS retargeting.
emailEmail onlysmsSMS onlyemail_smsEmail and SMS at their scheduled datesemail_retargeting_smsEmail followed by SMS retargetingtargetingobjectRequiredNested JSON object.
countriesarrayRequiredSelected countries: FR France, GB United Kingdom, ES Spain, IT Italy.
FRFranceGBUnited KingdomESSpainITItalygeographyobjectRequiredGeographic criteria grouped by selected country.
{country}objectRequiredNested JSON object.
regionsarrayOptionalRegion IDs returned by GET /targeting/geography with type=region.
departmentsarrayOptionalDepartment or administrative-area IDs returned by GET /targeting/geography with type=department.
citiesarrayOptionalCity IDs returned by GET /targeting/geography with type=city. City results include their region and department to distinguish duplicate names.
postal_codesarrayOptionalPostal codes available for the country.
radius_kmintegerOptionalOptional straight-line radius from 1 to 200 km, applied to every selected city and postcode. At least one city or postcode is required; regions and departments then only help disambiguate the selected origins.
profileobjectRequiredDemographic and household criteria; use an empty object for no filter.
age_minintegerOptionalMinimum inclusive age.
age_maxintegerOptionalMaximum inclusive age.
gender_idsarrayOptionalChoose one or more gender IDs shown below. An empty array includes all genders.
1maleMale2femaleFemale3unknownUnknowncsp_idsarrayOptionalChoose one or more socio-professional category IDs shown below. An empty array includes every category.
6csp_plusHigher socioeconomic group7csp_middleMiddle socioeconomic group8csp_minusLower socioeconomic group9unknownUnknownhousing_status_idsarrayOptionalChoose one or more housing-status IDs shown below. An empty array includes every status.
10ownerOwner11tenantTenant12otherOther status4unknownUnknownhousing_type_idsarrayOptionalChoose one or more housing-type IDs shown below. An empty array includes every type.
14houseHouse15apartmentApartment16otherOther housing type5unknownUnknowncar_owner_status_idsarrayOptionalChoose the car-owner ID shown below to target vehicle owners. An empty array applies no car-ownership filter.
18ownerOwns a vehicle19non_ownerDoes not own a vehicle20unknownUnknownexclusionsobjectRequiredRecent-contact and previous-campaign exclusions.
recent_daysenumOptional0 applies no recent-contact exclusion; 15, 30 or 60 excludes contacts already reached during that many previous days.
0No recent-contact exclusion15Exclude contacts reached in the last 15 days30Exclude contacts reached in the last 30 days60Exclude contacts reached in the last 60 dayscampaign_referencesarrayOptionalExclude contacts from sent campaigns owned by the account during the last 12 months.
list_idsarrayOptionalAt most two lists: one email and one telephone. Active, published, unexpired lists owned by the account. A matching email or telephone excludes the entire contact across channels. Versions are pinned for the campaign.
volumesobjectRequiredRequested volumes by country; keys must exactly match targeting.countries.
{country}stringRequiredRequested contact volume for this country.
contentsobjectRequiredContent by country; keys must exactly match targeting.countries.
{country}objectRequiredContent object for each selected country; its exact keys depend on product.
emailobjectConditionalRequired for every selected country when the product includes email.
sender_namestringConditionalEmail sender name.
subjectstringConditionalEmail subject line.
preheaderstringOptionalOptional email preheader.
htmlstringConditionalComplete email HTML.
smsobjectConditionalRequired for every selected country when the product includes SMS.
sender_namestringConditional1 to 11 ASCII letters or digits, with at least one letter; a value resembling a telephone number is rejected.
messagestringConditionalMessage body without the automatic STOP suffix. Maximum 4 SMS segments including the country STOP suffix, personalization reserves and the 20-character short link.
destination_urlstringOptionalOptional public HTTP(S) URL, maximum 2,048 characters. It is required exactly when the message contains one {{short_url}} tag; raw URLs in the message are rejected.
scheduleobjectRequiredIANA timezone and required dispatch dates. The standard lead time is 48 business hours; accounts enabled for urgent campaigns may use the next future 15-minute slot.
timezonestringRequiredIANA timezone used to validate the date offsets.
email_atstringConditionalRequired when the product includes email; forbidden for sms. For email_sms, it must be no more than 48 hours from sms_at.
sms_atstringConditionalRequired for sms and email_sms; forbidden for email and email_retargeting_sms. Local time must be between 08:00 and 19:45 and no more than 48 hours from email_at for email_sms.
retargeting_delay_hoursintegerOptionalOnly used for email_retargeting_sms: integer from 6 to 72 hours after the email; default 24.
promo_codestringOptionalOptional promotion code: 1 to 64 uppercase letters, digits, underscores or hyphens; first character must be a letter or digit.
https://api.dmseurope.com/v1/campaignscurl -X POST 'https://api.dmseurope.com/v1/campaigns' \
-H 'Authorization: Bearer API_KEY' \
-H 'Client-Reference: crm-campaign-20260829-001' \
-H 'Content-Type: application/json' \
-d '{
"name":"Summer launch 2026",
"product":"email_sms",
"targeting":{
"countries":["FR"],
"geography":{"FR":{"regions":[11],"departments":[75],"cities":[],"postal_codes":["75001"],"radius_km":20}},
"profile":{"age_min":30,"age_max":55,"gender_ids":[1],"csp_ids":[2],"housing_status_ids":[],"housing_type_ids":[],"car_owner_status_ids":[]},
"exclusions":{"recent_days":30,"campaign_references":[]}
},
"volumes":{"FR":4000},
"contents":{"FR":{
"email":{"sender_name":"My brand","subject":"Summer offer","preheader":"Discover our offer","html":"<p>Hello</p>"},
"sms":{"sender_name":"MyBrand","message":"Discover the offer: {{short_url}}","destination_url":"https://example.com/offer"}
}},
"schedule":{"timezone":"Europe/Paris","email_at":"2026-09-15T10:00:00+02:00","sms_at":"2026-09-15T12:00:00+02:00"},
"promo_code":null
}'<?php
$url = 'https://api.dmseurope.com/v1/campaigns';
$payload = <<<'JSON'
{
"name": "Summer launch 2026",
"product": "email_sms",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [
2
],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
},
"volumes": {
"FR": 4000
},
"contents": {
"FR": {
"email": {
"sender_name": "My brand",
"subject": "Summer offer",
"preheader": "Discover our offer",
"html": "<p>Hello</p>"
},
"sms": {
"sender_name": "MyBrand",
"message": "Discover the offer: {{short_url}}",
"destination_url": "https://example.com/offer"
}
}
},
"schedule": {
"timezone": "Europe/Paris",
"email_at": "2026-09-15T10:00:00+02:00",
"sms_at": "2026-09-15T12:00:00+02:00"
},
"promo_code": null
}
JSON;
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY',
'Client-Reference: crm-campaign-20260829-001',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/campaigns', {
method: 'POST',
headers: {
"Authorization": "Bearer API_KEY",
"Client-Reference": "crm-campaign-20260829-001",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "Summer launch 2026",
"product": "email_sms",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [
2
],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
},
"volumes": {
"FR": 4000
},
"contents": {
"FR": {
"email": {
"sender_name": "My brand",
"subject": "Summer offer",
"preheader": "Discover our offer",
"html": "<p>Hello</p>"
},
"sms": {
"sender_name": "MyBrand",
"message": "Discover the offer: {{short_url}}",
"destination_url": "https://example.com/offer"
}
}
},
"schedule": {
"timezone": "Europe/Paris",
"email_at": "2026-09-15T10:00:00+02:00",
"sms_at": "2026-09-15T12:00:00+02:00"
},
"promo_code": null
})
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/campaigns"
headers = {
"Authorization": "Bearer API_KEY",
"Client-Reference": "crm-campaign-20260829-001",
"Content-Type": "application/json"
}
payload = json.loads(r'''
{
"name": "Summer launch 2026",
"product": "email_sms",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [
2
],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
},
"volumes": {
"FR": 4000
},
"contents": {
"FR": {
"email": {
"sender_name": "My brand",
"subject": "Summer offer",
"preheader": "Discover our offer",
"html": "<p>Hello</p>"
},
"sms": {
"sender_name": "MyBrand",
"message": "Discover the offer: {{short_url}}",
"destination_url": "https://example.com/offer"
}
}
},
"schedule": {
"timezone": "Europe/Paris",
"email_at": "2026-09-15T10:00:00+02:00",
"sms_at": "2026-09-15T12:00:00+02:00"
},
"promo_code": null
}
''')
response = requests.request("POST", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
An active postpaid account with a positive limit is required.
ORDERING_NOT_ALLOWED
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
Client-Reference is missing.
Client-Reference does not match the required format.
A targeting value is unknown or unavailable.
The JSON body exceeds the permitted size.
Content-Type must be application/json.
The reference already identifies a campaign creation.
Available credit is insufficient.
The complete campaign violates a business rule.
/campaigns/{reference}Get a campaignReturns targeting, content, schedule, pricing, moderation and production information.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
referencestringRequiredPublic campaign reference.
https://api.dmseurope.com/v1/campaigns/{reference}curl 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/campaigns\/CMP-2026-0000123"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The campaign is absent or belongs to another account.
/campaigns/{reference}Replace a campaignFully replaces an editable campaign. The same Client-Reference may be reused with new content.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
Content-TypestringRequiredRequired JSON media type for the request body.
Client-ReferencestringRequiredBusiness reference for the update. It may be reused for later updates, with identical or different JSON.
referencestringRequiredPublic campaign reference.
namestringRequiredCampaign name.
productenumRequiredemail: email only; sms: SMS only; email_sms: both channels; email_retargeting_sms: email followed by SMS retargeting.
emailEmail onlysmsSMS onlyemail_smsEmail and SMS at their scheduled datesemail_retargeting_smsEmail followed by SMS retargetingtargetingobjectRequiredNested JSON object.
countriesarrayRequiredSelected countries: FR France, GB United Kingdom, ES Spain, IT Italy.
FRFranceGBUnited KingdomESSpainITItalygeographyobjectRequiredGeographic criteria grouped by selected country.
{country}objectRequiredNested JSON object.
regionsarrayOptionalRegion IDs returned by GET /targeting/geography with type=region.
departmentsarrayOptionalDepartment or administrative-area IDs returned by GET /targeting/geography with type=department.
citiesarrayOptionalCity IDs returned by GET /targeting/geography with type=city. City results include their region and department to distinguish duplicate names.
postal_codesarrayOptionalPostal codes available for the country.
radius_kmintegerOptionalOptional straight-line radius from 1 to 200 km, applied to every selected city and postcode. At least one city or postcode is required; regions and departments then only help disambiguate the selected origins.
profileobjectRequiredDemographic and household criteria; use an empty object for no filter.
age_minintegerOptionalMinimum inclusive age.
age_maxintegerOptionalMaximum inclusive age.
gender_idsarrayOptionalChoose one or more gender IDs shown below. An empty array includes all genders.
1maleMale2femaleFemale3unknownUnknowncsp_idsarrayOptionalChoose one or more socio-professional category IDs shown below. An empty array includes every category.
6csp_plusHigher socioeconomic group7csp_middleMiddle socioeconomic group8csp_minusLower socioeconomic group9unknownUnknownhousing_status_idsarrayOptionalChoose one or more housing-status IDs shown below. An empty array includes every status.
10ownerOwner11tenantTenant12otherOther status4unknownUnknownhousing_type_idsarrayOptionalChoose one or more housing-type IDs shown below. An empty array includes every type.
14houseHouse15apartmentApartment16otherOther housing type5unknownUnknowncar_owner_status_idsarrayOptionalChoose the car-owner ID shown below to target vehicle owners. An empty array applies no car-ownership filter.
18ownerOwns a vehicle19non_ownerDoes not own a vehicle20unknownUnknownexclusionsobjectRequiredRecent-contact and previous-campaign exclusions.
recent_daysenumOptional0 applies no recent-contact exclusion; 15, 30 or 60 excludes contacts already reached during that many previous days.
0No recent-contact exclusion15Exclude contacts reached in the last 15 days30Exclude contacts reached in the last 30 days60Exclude contacts reached in the last 60 dayscampaign_referencesarrayOptionalExclude contacts from sent campaigns owned by the account during the last 12 months.
list_idsarrayOptionalAt most two lists: one email and one telephone. Active, published, unexpired lists owned by the account. A matching email or telephone excludes the entire contact across channels. Versions are pinned for the campaign.
volumesobjectRequiredRequested volumes by country; keys must exactly match targeting.countries.
{country}stringRequiredRequested contact volume for this country.
contentsobjectRequiredContent by country; keys must exactly match targeting.countries.
{country}objectRequiredContent object for each selected country; its exact keys depend on product.
emailobjectConditionalRequired for every selected country when the product includes email.
sender_namestringConditionalEmail sender name.
subjectstringConditionalEmail subject line.
preheaderstringOptionalOptional email preheader.
htmlstringConditionalComplete email HTML.
smsobjectConditionalRequired for every selected country when the product includes SMS.
sender_namestringConditional1 to 11 ASCII letters or digits, with at least one letter; a value resembling a telephone number is rejected.
messagestringConditionalMessage body without the automatic STOP suffix. Maximum 4 SMS segments including the country STOP suffix, personalization reserves and the 20-character short link.
destination_urlstringOptionalOptional public HTTP(S) URL, maximum 2,048 characters. It is required exactly when the message contains one {{short_url}} tag; raw URLs in the message are rejected.
scheduleobjectRequiredIANA timezone and required dispatch dates. The standard lead time is 48 business hours; accounts enabled for urgent campaigns may use the next future 15-minute slot.
timezonestringRequiredIANA timezone used to validate the date offsets.
email_atstringConditionalRequired when the product includes email; forbidden for sms. For email_sms, it must be no more than 48 hours from sms_at.
sms_atstringConditionalRequired for sms and email_sms; forbidden for email and email_retargeting_sms. Local time must be between 08:00 and 19:45 and no more than 48 hours from email_at for email_sms.
retargeting_delay_hoursintegerOptionalOnly used for email_retargeting_sms: integer from 6 to 72 hours after the email; default 24.
promo_codestringOptionalOptional promotion code: 1 to 64 uppercase letters, digits, underscores or hyphens; first character must be a letter or digit.
https://api.dmseurope.com/v1/campaigns/{reference}curl -X PUT 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123' \
-H 'Authorization: Bearer API_KEY' \
-H 'Client-Reference: crm-update-20260829-001' \
-H 'Content-Type: application/json' \
-d '{
"name":"Summer launch 2026",
"product":"email_sms",
"targeting":{
"countries":["FR"],
"geography":{"FR":{"regions":[11],"departments":[75],"cities":[],"postal_codes":["75001"],"radius_km":20}},
"profile":{"age_min":30,"age_max":55,"gender_ids":[1],"csp_ids":[2],"housing_status_ids":[],"housing_type_ids":[],"car_owner_status_ids":[]},
"exclusions":{"recent_days":30,"campaign_references":[]}
},
"volumes":{"FR":4000},
"contents":{"FR":{
"email":{"sender_name":"My brand","subject":"Summer offer","preheader":"Discover our offer","html":"<p>Hello</p>"},
"sms":{"sender_name":"MyBrand","message":"Discover the offer: {{short_url}}","destination_url":"https://example.com/offer"}
}},
"schedule":{"timezone":"Europe/Paris","email_at":"2026-09-15T10:00:00+02:00","sms_at":"2026-09-15T12:00:00+02:00"},
"promo_code":null
}'<?php
$url = 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123';
$payload = <<<'JSON'
{
"name": "Summer launch 2026",
"product": "email_sms",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [
2
],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
},
"volumes": {
"FR": 4000
},
"contents": {
"FR": {
"email": {
"sender_name": "My brand",
"subject": "Summer offer",
"preheader": "Discover our offer",
"html": "<p>Hello</p>"
},
"sms": {
"sender_name": "MyBrand",
"message": "Discover the offer: {{short_url}}",
"destination_url": "https://example.com/offer"
}
}
},
"schedule": {
"timezone": "Europe/Paris",
"email_at": "2026-09-15T10:00:00+02:00",
"sms_at": "2026-09-15T12:00:00+02:00"
},
"promo_code": null
}
JSON;
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY',
'Client-Reference: crm-update-20260829-001',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123', {
method: 'PUT',
headers: {
"Authorization": "Bearer API_KEY",
"Client-Reference": "crm-update-20260829-001",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "Summer launch 2026",
"product": "email_sms",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [
2
],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
},
"volumes": {
"FR": 4000
},
"contents": {
"FR": {
"email": {
"sender_name": "My brand",
"subject": "Summer offer",
"preheader": "Discover our offer",
"html": "<p>Hello</p>"
},
"sms": {
"sender_name": "MyBrand",
"message": "Discover the offer: {{short_url}}",
"destination_url": "https://example.com/offer"
}
}
},
"schedule": {
"timezone": "Europe/Paris",
"email_at": "2026-09-15T10:00:00+02:00",
"sms_at": "2026-09-15T12:00:00+02:00"
},
"promo_code": null
})
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/campaigns\/CMP-2026-0000123"
headers = {
"Authorization": "Bearer API_KEY",
"Client-Reference": "crm-update-20260829-001",
"Content-Type": "application/json"
}
payload = json.loads(r'''
{
"name": "Summer launch 2026",
"product": "email_sms",
"targeting": {
"countries": [
"FR"
],
"geography": {
"FR": {
"regions": [
11
],
"departments": [
75
],
"cities": [],
"postal_codes": [
"75001"
],
"radius_km": 20
}
},
"profile": {
"age_min": 30,
"age_max": 55,
"gender_ids": [
1
],
"csp_ids": [
2
],
"housing_status_ids": [],
"housing_type_ids": [],
"car_owner_status_ids": []
},
"exclusions": {
"recent_days": 30,
"campaign_references": []
}
},
"volumes": {
"FR": 4000
},
"contents": {
"FR": {
"email": {
"sender_name": "My brand",
"subject": "Summer offer",
"preheader": "Discover our offer",
"html": "<p>Hello</p>"
},
"sms": {
"sender_name": "MyBrand",
"message": "Discover the offer: {{short_url}}",
"destination_url": "https://example.com/offer"
}
}
},
"schedule": {
"timezone": "Europe/Paris",
"email_at": "2026-09-15T10:00:00+02:00",
"sms_at": "2026-09-15T12:00:00+02:00"
},
"promo_code": null
}
''')
response = requests.request("PUT", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
An active postpaid account with a positive limit is required.
ORDERING_NOT_ALLOWED
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
Client-Reference is missing.
Client-Reference does not match the required format.
A targeting value is unknown or unavailable.
The JSON body exceeds the permitted size.
Content-Type must be application/json.
The campaign is absent or belongs to another account.
The campaign status does not allow replacement.
Available credit is insufficient.
The complete campaign violates a business rule.
/campaigns/{reference}/cancelCancel a campaignCancels an eligible campaign and releases reserved credit when applicable. Client-Reference is not required.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
Content-TypestringConditionalRequired only when a JSON cancellation body is sent.
referencestringRequiredPublic campaign reference.
reasonstringOptionalOptional cancellation reason.
https://api.dmseurope.com/v1/campaigns/{reference}/cancelcurl -X POST 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123/cancel' \
-H 'Authorization: Bearer API_KEY' -H 'Content-Type: application/json' \
-d '{"reason":"Cancelled by CRM operator"}'<?php
$url = 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123/cancel';
$payload = <<<'JSON'
{
"reason": "Cancelled by CRM operator"
}
JSON;
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123/cancel', {
method: 'POST',
headers: {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"reason": "Cancelled by CRM operator"
})
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/campaigns\/CMP-2026-0000123\/cancel"
headers = {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
}
payload = json.loads(r'''
{
"reason": "Cancelled by CRM operator"
}
''')
response = requests.request("POST", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
The JSON body exceeds the permitted size.
Content-Type must be application/json.
The campaign is absent or belongs to another account.
The campaign status does not allow cancellation.
/campaigns/{reference}/statisticsGet campaign statisticsReturns current totals and breakdowns by country, language and channel.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
referencestringRequiredPublic campaign reference.
https://api.dmseurope.com/v1/campaigns/{reference}/statisticscurl 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123/statistics' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123/statistics';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/campaigns/CMP-2026-0000123/statistics', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/campaigns\/CMP-2026-0000123\/statistics"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The campaign is absent or belongs to another account.
/invoicesList invoicesReturns invoices and credit notes. Each item contains pdf_url, whose path includes opaque_reference.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
pageintegerOptionalRequested page number.
per_pageintegerOptionalNumber of results per page.
typeenumOptionalDocument type filter.
invoiceInvoicecredit_noteCredit notestatusstringOptionalExact invoice lifecycle status.
payment_statusstringOptionalExact payment status.
issued_fromstringOptionalInclusive minimum issue date.
issued_tostringOptionalInclusive maximum issue date.
campaign_referencestringOptionalPublic campaign reference filter.
https://api.dmseurope.com/v1/invoicescurl 'https://api.dmseurope.com/v1/invoices?page=1&per_page=20&type=invoice&payment_status=paid' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/invoices?page=1&per_page=20&type=invoice&payment_status=paid';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/invoices?page=1&per_page=20&type=invoice&payment_status=paid', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/invoices?page=1&per_page=20&type=invoice&payment_status=paid"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
/invoices/{number}Get an invoiceReturns the structured legal document and pdf_url containing opaque_reference.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
numberstringRequiredLegal invoice or credit-note number.
https://api.dmseurope.com/v1/invoices/{number}curl 'https://api.dmseurope.com/v1/invoices/INV-2026-000123' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/invoices/INV-2026-000123';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/invoices/INV-2026-000123', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/invoices\/INV-2026-000123"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The document is absent or belongs to another account.
/exclusion-listsList exclusion listsActive lists and IDs available for counts and campaigns.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
pageintegerOptionalRequested page number.
usableenumOptional1: published, unexpired lists only; 0: all active lists. Pages contain up to 50 results.
https://api.dmseurope.com/v1/exclusion-listscurl -X GET 'https://api.dmseurope.com/v1/exclusion-lists' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/exclusion-lists';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/exclusion-lists', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/exclusion-lists"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
The JSON body exceeds the permitted size.
A parameter or JSON field is invalid.
Content-Type must be application/json.
/exclusion-listsCreate an exclusion listCreate a named email or telephone list, then send its content with PATCH.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
Content-TypestringRequiredRequired JSON media type for the request body.
namestringRequiredName of 1–190 characters. With PATCH, send name alone to rename. Renaming does not extend the 12-month content retention period.
kindenumRequiredemail for email hashes, phone for telephone hashes; immutable type. After publication, use list_id in targeting.exclusions.list_ids for audience counts and campaigns.
https://api.dmseurope.com/v1/exclusion-listscurl -X POST 'https://api.dmseurope.com/v1/exclusion-lists' \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
-d '{"name":"Existing customers","kind":"email"}'<?php
$url = 'https://api.dmseurope.com/v1/exclusion-lists';
$payload = <<<'JSON'
{
"name": "Existing customers",
"kind": "email"
}
JSON;
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/exclusion-lists', {
method: 'POST',
headers: {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "Existing customers",
"kind": "email"
})
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/exclusion-lists"
headers = {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
}
payload = json.loads(r'''
{
"name": "Existing customers",
"kind": "email"
}
''')
response = requests.request("POST", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
The JSON body exceeds the permitted size.
A parameter or JSON field is invalid.
Content-Type must be application/json.
/exclusion-lists/{list_id}Get or export an exclusion listMetadata, import progress or paginated export using export=1.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
list_idstringRequiredList identifier owned by the authenticated account, returned at creation.
exportenumOptional0 (default) returns list, version and imports with status and counters. 1 returns version_id, data (up to 5,000 newline-separated hashes) and next_cursor for pagination.
cursorstringOptionalOpaque next_cursor from the previous page; omit or leave empty to start. Repeat with the same version_id until next_cursor=null.
version_idstringConditionalVersion from the first export page, required with cursor. Keep it for all pages; if it changes, version_changed_recount (409) requires restarting.
https://api.dmseurope.com/v1/exclusion-lists/{list_id}curl -X GET 'https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef', {
method: 'GET',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/exclusion-lists\/excl_0123456789abcdef0123456789abcdef"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("GET", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
The JSON body exceeds the permitted size.
A parameter or JSON field is invalid.
Content-Type must be application/json.
/exclusion-lists/{list_id}Update an exclusion listRename, replace, add or remove hashes, resume or cancel an import.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
Content-TypestringRequiredRequired JSON media type for the request body.
list_idstringRequiredList identifier owned by the authenticated account, returned at creation.
namestringConditionalName of 1–190 characters. With PATCH, send name alone to rename. Renaming does not extend the 12-month content retention period.
operation_keystringConditionalRequired with data or cancel. Key of 8–80 letters, digits, hyphens or underscores. Keep the same key and mode across chunks and retries; use a new key for another import.
datastringConditionalUTF-8 text separated by commas, semicolons, tabs or line breaks. Unsalted hexadecimal MD5 (32 characters) or SHA256 (64), detected automatically. Before hashing: lowercase and trim emails; E.164 telephones including +. Normalization is the client’s responsibility. Invalid values are ignored and duplicates removed; globally malformed text is rejected (row/byte when available). Maximum: 1 MiB/chunk, 350,000,000 bytes/import, 5,000,000 distinct hashes and 6 MiB/JSON body.
modeenumOptionalreplace replaces, add adds, remove removes. For add/remove, HTTP 202 with chunk_accepted=false means the base copy is pending: wait for Retry-After and repeat the identical request.
sequenceintegerOptionalChunk number from 0 (default). To resume, read imports[].next_chunk using GET. Repeating a chunk requires identical text; otherwise chunk_conflict (409).
finalbooleanOptionaltrue (default) publishes atomically after the last chunk; false for intermediate chunks. Current content remains usable. import.status=ready confirms publication; an import without valid hashes is rejected.
cancelbooleanOptionaltrue cancels an open import without changing published content. Send only operation_key and cancel; use a new key to restart.
https://api.dmseurope.com/v1/exclusion-lists/{list_id}curl -X PATCH 'https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef' \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
-d '{"operation_key":"crm_customers_20261101","data":"d41d8cd98f00b204e9800998ecf8427e;0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}'<?php
$url = 'https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef';
$payload = <<<'JSON'
{
"operation_key": "crm_customers_20261101",
"data": "d41d8cd98f00b204e9800998ecf8427e;0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
}
JSON;
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef', {
method: 'PATCH',
headers: {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"operation_key": "crm_customers_20261101",
"data": "d41d8cd98f00b204e9800998ecf8427e;0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
})
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/exclusion-lists\/excl_0123456789abcdef0123456789abcdef"
headers = {
"Authorization": "Bearer API_KEY",
"Content-Type": "application/json"
}
payload = json.loads(r'''
{
"operation_key": "crm_customers_20261101",
"data": "d41d8cd98f00b204e9800998ecf8427e;0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
}
''')
response = requests.request("PATCH", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
The JSON body exceeds the permitted size.
A parameter or JSON field is invalid.
Content-Type must be application/json.
/exclusion-lists/{list_id}Delete an exclusion listImmediately prevents new uses while preserving scheduled campaign exclusions.AuthorizationstringRequiredActive API key sent with the Bearer scheme.
Accept-LanguageenumOptionalPreferred error-message language; English is used by default.
list_idstringRequiredList to remove immediately from new uses. Scheduled campaigns keep their version until 30 days after closure or cancellation. Physical erasure is progressive; the client is notified after effective deletion.
https://api.dmseurope.com/v1/exclusion-lists/{list_id}curl -X DELETE 'https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef' \
-H 'Authorization: Bearer API_KEY'<?php
$url = 'https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef';
$curl = curl_init($url);
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer API_KEY'
],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
var_dump($status, json_decode((string) $response, true));// Run this code server-side with Node.js 18 or later.
const response = await fetch('https://api.dmseurope.com/v1/exclusion-lists/excl_0123456789abcdef0123456789abcdef', {
method: 'DELETE',
headers: {
"Authorization": "Bearer API_KEY"
}
});
const data = await response.json();
if (!response.ok) throw new Error(JSON.stringify(data));
console.log(data);import json
import requests
url = "https:\/\/api.dmseurope.com\/v1\/exclusion-lists\/excl_0123456789abcdef0123456789abcdef"
headers = {
"Authorization": "Bearer API_KEY"
}
response = requests.request("DELETE", url, headers=headers)
response.raise_for_status()
print(response.json())Success — All HTTP responses include X-Request-Id; JSON responses also include request_id.
The API is temporarily disabled.
The server configuration is incomplete.
The Bearer header is missing.
The API key is invalid or revoked.
The account is not active.
The account cannot use the current environment.
The request quota has been exceeded.
An unexpected server error occurred.
A parameter or JSON field is invalid.
The JSON body cannot be decoded.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
A parameter or JSON field is invalid.
The JSON body exceeds the permitted size.
A parameter or JSON field is invalid.
Content-Type must be application/json.