Skip to content
campaiDeveloper
campai.com

Crm · Contacts

POST/{organizationId}/crm/contacts/tags/rename

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

  • tagstringrequired

    1–40 characters

  • newTagstringrequired

    1–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'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • affectedRecordsinteger

    at 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.renameTagInEntities jobs on DefaultQueue.

Errors

Other errors

StatusErrorWhen
403Missing permission: permissionsIf any required contact-type permission is missing, the endpoint returns 403 FORBIDDEN with key organization.organizationPermissions.missingPermissions.
403Must have access to all mandatesIf 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.