Skip to content
campaiDeveloper
campai.com

Crm · Plans

POST/{organizationId}/{mandateId}/crm/plans/tags/rename

Rename tag

Renames a plan tag case-insensitively on plans and contracts, or merges it with an existing tag. It takes an organization ID, a nullable mandate ID, the current tag and the new tag. It returns affectedRecords, the number of matching plans; the records 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 and plan.remove permissions.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

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/YOUR_MANDATE_ID/crm/plans/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

  • For a change of case only, matching tag documents are updated with the new spelling.
  • When the normalized name changes, matching old tag documents are deleted.
  • When records gain the new tag, its tag documents are created or updated and their usage counts increased.
  • Starts common.renameTagInEntities jobs on DefaultQueue to rename tags in the configured records.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.