Skip to content
API Reference/
/
Remove a tag from an enti...

Remove a tag from an entity

Request

Removes a tag from an entity.

Security
oauth2_client_credentials or oauth2_authorization_code
Path
entitystringrequired

The entity id.

Bodyapplication/jsonrequired
tagobject(tag)required

Required. The tag to remove from the entity.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/entities/{entity}:removeTag' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tag": {
      "tagType": "string",
      "tagDefinitionId": "string"
    }
  }'

Responses

Success

Bodyapplication/json
One of:
namestring(name)

(IDENTIFIER) The resource name of the entity. Format: entities/{entity} string.resource_name = ["entities/*"] // value must be a valid resource name

displayNamestring(display_name)

(OPTIONAL) Optional. A mutable, user-settable field for providing a human-readable name for the entity, to be used in user interfaces. Must be <= 63 characters. string.display_name = true // value must be at most 63 characters

Example:"Example Financial Services Ltd"
contactInfoobject(contact_info)

(OPTIONAL)

registrationobject(registration)

(OPTIONAL)

riskDetailsobject(risk_details)

(OPTIONAL)

entityRelationshipsArray of objects(entity_relationships)

(OPTIONAL)

externalIdsobject(external_ids)

(OPTIONAL)

tagsArray of objects(tags)

(OPTIONAL) Optional. Tags associated with the entity.

customFieldSettingRevisionstring, non-empty(custom_field_setting_revision)

(OPTIONAL) The resource name of the schema revision this request was filled against. Format: tenants/{tenant}/customFieldSettings/{custom_field_setting}/revisions/{revision}

customFieldValuesobject(custom_field_values)

(OPTIONAL) The field values organised by group. Each outer map key is the group key; each inner Struct holds field_key → value pairs. Values are raw JSON types matching FormKit output: string, number, bool, or list of strings. The backend validates value types against the field definitions at runtime.

createTimestring, (date-time)(create_time)read-only

Output only. The timestamp when the entity was created.

Example:"2023-01-15T01:30:15.01Z"
updateTimestring, (date-time)(update_time)read-only

Output only. The timestamp when the entity was most recently updated.

Example:"2023-01-15T01:30:15.01Z"
purgeTimestring, (date-time)(purge_time)read-only

Output only. The timestamp when the entity will be purged if soft-deleted. See AIP-164.

Example:"2023-01-15T01:30:15.01Z"
annotationsobject(annotations)

(OPTIONAL) Optional. Annotations for arbitrary metadata. See AIP-148.

etagstring(etag)

(OPTIONAL) Optional. The etag of the resource. Used for optimistic concurrency control as per AIP-154. string.etag = true // etag must be at most 256 characters

Example:"abc123"
companyobject(company)required
Response
{
  "name": "string",
  "displayName": "Example Financial Services Ltd",
  "contactInfo": {
    "telephone": [ … ],
    "businessTelephone": [ … ],
    "emailAddress": [ … ],
    "primaryContacts": [ … ],
    "website": [ … ],
    "registeredBusinessAddresses": [ … ],
    "principalBusinessAddresses": [ … ],
    "residentialAddresses": [ … ]
  },
  "registration": {
    "property1": { … },
    "property2": { … }
  },
  "riskDetails": {
    "riskStatus": "RISK_STATUS_UNSPECIFIED",
    "riskStatusReason": "RISK_STATUS_REASON_UNSPECIFIED",
    "riskRating": "string"
  },
  "entityRelationships": [
    { … }
  ],
  "externalIds": {
    "cherryhub": "string",
    "custom": { … }
  },
  "tags": [
    { … }
  ],
  "customFieldSettingRevision": "string",
  "customFieldValues": {
    "property1": { … },
    "property2": { … }
  },
  "createTime": "2023-01-15T01:30:15.01Z",
  "updateTime": "2023-01-15T01:30:15.01Z",
  "purgeTime": "2023-01-15T01:30:15.01Z",
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "etag": "abc123",
  "company": {
    "type": "COMPANY_TYPE_UNSPECIFIED",
    "industry": "Financial Services",
    "contacts": [ … ]
  }
}