BLblockaid-official
Label Management

Update Label Assignment

Changed on

Update a label assignment (partial). You can update any combination of label (changing it also updates result_type automatically), chain, tags, and comment. The id, created_at, and created_by fields are read-only and never modified.

patch/v0/platform/labels/{id}

Request

Path parameters

idstring uuid required

Label assignment ID.

The unique ID (uuid) of the label assignment, as returned in the id field of an apply / list / search response.

Request body

labelstring

New label name (case-insensitive match against the catalog); changing it also updates result_type. Omit to leave unchanged.

chainstring nullable

New chain coverage: a chain name scopes the assignment to exactly that chain; null switches it to all-chains (sticky). Omit to leave unchanged. Not applicable to domain assignments (domains are never chain-scoped); supplying chain when updating a domain label returns 422.

tagsstring[] nullable

Replacement set of tags. An array replaces the existing tags; an empty array or null clears all tags. Omit to leave tags unchanged.

commentstring nullable

Updated comment; null clears it. Omit to leave unchanged.

Response

Label assignment updated

idstring uuid required

Unique ID of this label assignment.

identifierstring required

The labeled address, domain or token.

identifier_type'address' | 'domain' | 'token' required

The type of the labeled identifier.

chainstring nullable required

The chain this label applies to. null means the label applies to ALL chains (sticky); chain is always null for domains, which are not chain-scoped.

labelstring required

The applied label name.

result_type'Malicious' | 'Benign' required

Whether this label marks the entity as Malicious (block) or Benign (allow). Derived from the label.

tagsstring[] required

Tags grouping this label.

commentstring nullable

Free-text note explaining the label, if any.

created_bystring required

Who created the assignment (e.g. "API" or a user identifier).

updated_bystring required

Who last updated the assignment.

created_atstring date-time required

Creation timestamp (ISO 8601, UTC).

updated_atstring date-time required

Last-update timestamp (ISO 8601, UTC).

Changes