Shipeasy
APIOperations

Replace an item's tags

Replaces the item's whole tag set with tags: names not yet in the project are created, attached names not in the list are detached, and [] clears every tag.…

Replaces the item's whole tag set with tags: names not yet in the project are created, attached names not in the list are detached, and [] clears every tag. Names are deduped case-insensitively, reusing an existing tag's casing (sending iOS when ios exists attaches ios).

Use cases
  • Tag an item — { "tags": ["checkout", "ios"] }.
  • Clear tags — { "tags": [] }.

To add or remove a few tags without restating the rest, use the incremental PATCH instead.

PUT
/api/admin/tags/{entityType}/{entityId}

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

entityType*string
Value in"ops" | "flag" | "config" | "killswitch" | "metric" | "error" | "alert_rule"
entityId*string

The item's handle — an ops item's number (e.g.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://shipeasy.ai/api/admin/tags/ops/string" \  -H "Content-Type: application/json" \  -d '{    "tags": [      "checkout",      "ios"    ]  }'
{
  "entityType": "ops",
  "entityId": "fb_01j7w8a1b2c3d4e5f6g7h8i9j0",
  "tags": [
    "checkout",
    "ios"
  ]
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?