v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Companies

Add Company Source Tag

Adds a tag for the company source to the company profile page. Added tag is displayed in the Tags section of the Tags tab of the company profile page.

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

Path parameters

companyIdstring required

The identifier for the company to which the source 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

idinteger

The identifier for the Company Source Tag for the company.

companyIdinteger

The identifier for the company.

companySourceIdinteger

The identifier for the Company Source option.

companySourceNamestring

The name of the Company Source option.

Example request

{
  "id": 12345,
  "companyId": 67890,
  "companySourceId": 45678,
  "companySourceName": "LinkedIn"
}

Response

The created company source tag.

idinteger

The identifier for the Company Source Tag for the company.

companyIdinteger

The identifier for the company.

companySourceIdinteger

The identifier for the Company Source option.

companySourceNamestring

The name of the Company Source option.

Example response

{
  "id": 12345,
  "companyId": 67890,
  "companySourceId": 45678,
  "companySourceName": "LinkedIn"
}