Skip to content
campaiDeveloper
campai.com

Booking · Services

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

Rename tag

Renames a supplementary service tag case-insensitively, or merges it with an existing tag. Supply organizationId, mandateId, tag, and newTag; both tag names are trimmed and must be 1–40 characters. The response gives affectedRecords, the number of matching supplementary services. Those records are updated 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 the mandate.read permission.
  • The caller needs the supplementaryService.remove permission.

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/services/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 normalized names match, matching tag documents are updated with the new spelling.
  • When the normalized names differ, matching old tag documents are deleted.
  • When the normalized names differ and records gain the new tag, its tag documents are created or updated with the added usage.
  • Starts the common.renameTagInEntities job on DefaultQueue to update supplementary services in the background.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.