Skip to content
campaiDeveloper
campai.com

Booking · Resources

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

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.read and resource.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/resources/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 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.renameTagInEntities jobs on DefaultQueue for 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.