OBJECT
TagEntity
Label that users attach to records such as accounts, contacts or opportunities to categorize them.
link GraphQL Schema definition
- type TagEntity {
- # True when the record is protected against deletion because it must always exist
- # in the space. Deleting a record that is not protected can still fail on other
- # checks. Read-only.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # User who created the tag.
- : ClientEntity
- # For tags scoped to specific record types (e.g. specific Account types), the list
- # of type ids the tag can be assigned to. Empty/null means no per-type
- # restriction.
- : [UUID]
- # Display color of the tag, encoded as a 24-bit RGB integer: (red << 16) | (green
- # << 8) | blue.
- : Int!
- # Id of the creating user.
- : ID
- # For tags scoped to custom entities, the api name of the custom entity the tag
- # belongs to. Required for custom-entity tags and must be empty for all other
- # tags.
- : String
- # When false, the tag is hidden in pickers and cannot be assigned to new records.
- : Boolean
- # Name of the entity and its default text representation.
- : String!
- # Bit flags of the entities the tag can be attached to, added together: Contact 1,
- # Account 2, Opportunity 4, Lead 8, Project 16, Email 32, Process 64, Appointment
- # 128, Task 256, Quote 512, CustomEntity 1024, Solution 2048.
- : Int
- # When true, the tag name is treated as a translation key and localized in the UI;
- # otherwise the literal name is shown.
- : Boolean
- # Revision when entity was lastly changed.
- : Int
- # Permissions the current user has on this record, out of the requested ones.
- #
- # Arguments
- # permissions: Permissions to check; the result lists those the
- # current user has.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- CreateTagPayloadResult of the createTag mutation.
- DeleteTagPayloadResult of the deleteTag mutation.
- TagEntityEdgeA Relay edge containing a `TagEntity` and its cursor.
- TagRelationEntityAssignment of a tag to a record.
- TagRepositoryRead operations for Tag records.
- UpdateTagPayloadResult of the updateTag mutation.