Skip to content
campaiDeveloper
campai.com

Booking · Events

POST/{organizationId}/{mandateId}/booking/events/tags/rename

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

  • 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/booking/events/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

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