Booking · Resources
Rename tag
Renames a resource tag case-insensitively on resources and dependent booking views and discount codes. Supply organizationId, nullable mandateId, tag, and newTag; tag names are trimmed and must be 1–40 characters. If the new name matches an existing tag, the tags are merged. The endpoint returns affectedRecords, the number of matching resources, and renames the records 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.readandresource.remove.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
tagstringrequired1–40 characters
-
newTagstringrequired1–40 characters
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/resources/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/resources/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/resources/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
{
"affectedRecords": 0
}
What else happens
- If the normalized tag names are the same, the matching tag documents are updated with the new spelling.
- If the normalized tag names differ, matching old tag documents are deleted. New tag documents are inserted or updated for resources that gain the new tag.
- The endpoint queues
common.renameTagInEntitiesjobs onDefaultQueuefor resources, resource booking views, and resource discount codes.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.