Update Tag

PUT

/v1/tags/{id}

Update an existing tag by its ID. Verifies domain ownership before updating. Use domain (domain name) and name for tag name. The legacy fields domainId and tagName are still accepted for backwards compatibility.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Path Params

Body Params application/jsonRequired

Example

{
    "domain": "b2bforcelabs.com",
    "domainId": "cmg9l788c0001la04ctg7t1j4",
    "name": "newsletter",
    "tagName": "newsletter",
    "tagColor": "#FF5733"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/tags/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "b2bforcelabs.com",
    "domainId": "cmg9l788c0001la04ctg7t1j4",
    "name": "newsletter",
    "tagName": "newsletter",
    "tagColor": "#FF5733"
}'

Responses

🟢200

application/json

Tag updated successfully

Bodyapplication/json

Example

{
    "status": 200,
    "message": "Tag updated successfully.",
    "data": {
        "id": "tag_abc1",
        "tagName": "newsletter",
        "name": "newsletter",
        "domainId": "cmg9l788c0001la04ctg7t1j4"
    }
}

🟠400

🟠401

🟠404

🔴500

Create Tag

Delete Tag