Booking · Events
Rename tag
Renames an event tag case-insensitively, or merges it with an existing tag. Provide organizationId, a nullable mandateId, tag, and newTag; each tag name must be 1–40 characters after trimming. The endpoint returns affectedRecords, the number of matching events. Events and dependent booking views and discount codes are renamed 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
event.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/booking/events/tags/rename' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/events/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/booking/events/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 documents are updated with the new spelling.
- When the names normalize to different values, matching old tag documents are deleted.
- For groups where affected events gain the new tag, the new tag document is created or updated and its usage is increased.
- Starts
common.renameTagInEntitiesjobs onDefaultQueueto rename records in the background.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.