Rename Label

PUT

/onebox/labels

Rename an existing label.

Every message carrying the old label is re-tagged. emailsUpdated reports how many were touched — it is 0 when the label exists but is not applied to anything.

Optionally pass color to change the colour in the same call.

Example

{
  "userId": "K5PF9Y068AMDGENV5BTCNJJZK55F",
  "account": "andrew.lawyer@aurumlawyer.com",
  "oldLabelName": "Priority",
  "newLabelName": "High Priority"
}

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Label renamed.

Bodyapplication/json

🟠401Unauthorized

🟠404Not Found

🟠422Validation Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://customers.coldmailreseller.com/api/v1/integration/onebox/labels' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "K5PF9Y068AMDGENV5BTCNJJZK55F",
    "account": "andrew.lawyer@aurumlawyer.com",
    "oldLabelName": "Priority",
    "newLabelName": "High Priority",
    "color": "#FF5500"
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Label renamed",
    "data": {
        "oldLabelName": "Priority",
        "newLabelName": "High Priority",
        "color": "#FF5500",
        "emailsUpdated": 0
    }
}

Modified at 2026-10-02 12:23:15

Create Label

Delete Label

Rename Label

Example#

Request

Responses

Example