Skip to content
campaiDeveloper
campai.com

Crm · Mailings

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

Rename tag

Renames a mailing tag case-insensitively on mailings and in contacts’ mailing preferences. It takes organizationId, mandateId, tag, and newTag; both tag names are trimmed and must be 1–40 characters long. If the new name is an existing tag, the tags are merged. The response contains affectedRecords, the number of matching mailings, while record updates run 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 mailing.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/crm/mailings/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 records keep their entries and receive the new spelling.
  • When the normalized names differ, matching old tag records are deleted.
  • When mailings gain a differently normalized tag, its tag records are created or updated and their usage counts are increased.
  • Starts common.renameTagInEntities jobs on DefaultQueue for the configured record paths.

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.