API v1 ReferenceCompany Tags

Adds tags to the specified company.

Adds the submitted tags and returns the tags assigned to the specified company. <Check title="Required Permissions" icon="key">The user must have `company-master-data:write` permission for the specified company.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequiredformat: "uuid"
The id of the company to add tags to.

Request

The model containing the tags to be added.
namestringRequired0-255 characters
The name of the tag to delete.
colorstring or nullOptional
The color of the tag. Use one of 'red', 'coral', 'yellow', 'green', 'teal', 'arctic', 'blue', 'azure', 'purple', 'violet'.

Response

OK
idstringOptionalformat: "uuid"
The id of the entity.
createdOnstringOptionalformat: "date-time"
The date this entity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this entity.
updatedOnstringOptionalformat: "date-time"
The date this entity was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this entity.
namestring or nullOptional
The name of the tag.
colorstring or nullOptional
The color of the tag.

Errors

400
Bad Request Error
401
Unauthorized Error