Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies

Add Company Tag

Adds a tag to the company profile. Added tag is displayed in the Tags section of the Tags tab on the company’s profile page. Tags may comprise the information that can help to further categorize the company and make the company profile more searchable.

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

Path parameters

companyIdstring required

An identifier for the company to which the tag is being added.

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.

Request body

tagIdinteger

The identifier for the tag.

tagNamestring

The name of the tag.

companyIdinteger

The identifier for the company.

Example request

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

Response

The created 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
}