Crm · Mailings
Rename tag
Renames a mailing tag case-insensitively on mailings and in contacts’ mailing preferences. It takes organizationId, mandateId, tag, and newTag; both tag names are trimmed and must be 1–40 characters long. If the new name is an existing tag, the tags are merged. The response contains affectedRecords, the number of matching mailings, while record updates run in the background.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller needs
mandate.read. - The caller needs
mailing.remove.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
tagstringrequired1–40 characters
-
newTagstringrequired1–40 characters
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/mailings/tags/rename' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/mailings/tags/rename", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/mailings/tags/rename', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
affectedRecordsintegerat least 0
Response200
{
"affectedRecords": 0
}
What else happens
- When the old and new names normalize to the same value, matching tag records keep their entries and receive the new spelling.
- When the normalized names differ, matching old tag records are deleted.
- When mailings gain a differently normalized tag, its tag records are created or updated and their usage counts are increased.
- Starts
common.renameTagInEntitiesjobs onDefaultQueuefor the configured record paths.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.