Crm · Contacts
Rename tag
Renames a contact tag case-insensitively across an organization’s contacts, member booking restrictions, and team membership rules. Provide organizationId, tag, and newTag; if the new name already exists, the tags are merged. The endpoint returns affectedRecords, the number of matching contacts, and renames 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 must have
tag.edit.
Request
Path parameters
-
organizationIdidrequired
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/crm/contacts/tags/rename' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/contacts/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/crm/contacts/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
- If only the tag’s case changes, matching tag records are updated with the new spelling.
- If the normalized tag name changes, matching old tag records are deleted.
- When contacts gain a different normalized tag, tag records for the new name are created or updated with the added usage.
- The endpoint starts
common.renameTagInEntitiesjobs onDefaultQueue.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 403 | Missing permission: permissions | If any required contact-type permission is missing, the endpoint returns 403 FORBIDDEN with key organization.organizationPermissions.missingPermissions. |
| 403 | Must have access to all mandates | If the caller has mandate restrictions, the endpoint returns 403 FORBIDDEN with key routes.crm.contacts.tags.allMandatesRequired. |
Marked words such as permissions are filled in with the actual value when the error happens.
Errors nearly every request can meet are listed under Errors.