Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies

Remove Company Tag

Permanently deletes the specified company tag from the Tags tab of the specified company profile.

delete/v1/company/{companyId}/company-tag

Path parameters

companyIdstring required

An identifier for the company from which the tag is being removed.

Query parameters

itemIdstring required

The identifier for the Company Tag to be removed.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The removed company tag.

tagIdinteger

The identifier for the tag.

tagNamestring

The name of the tag.

companyIdinteger

The identifier for the company.

Example response

{
  "tagId": 12345,
  "tagName": "Hospitality",
  "companyId": 17845
}