GraphQL RepositoriesemailLabelRelation

`entities.emailLabelRelation`

Read email label relation records with the emailLabelRelation repository, and change them with the email label relation mutations. Same records as the REST EmailLabelRelations entity.

Example: first three email label relation recordsGraphQLcURL

query FirstEmailLabelRelations {
  entities {
    emailLabelRelation {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstEmailLabelRelations { entities { emailLabelRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { emailLabelRelation { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	EmailLabelRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[EmailLabelRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: EmailLabelRelationFilterInput, orderBy: [EmailLabelRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[EmailLabelRelationEntity!]!
QUERY	`getByCriteria`(filter: EmailLabelRelationFilterInput, orderBy: [EmailLabelRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	EmailLabelRelationEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createEmailLabelRelation`(input: CreateEmailLabelRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateEmailLabelRelationPayload
MUTATION	`updateEmailLabelRelation`(input: UpdateEmailLabelRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateEmailLabelRelationPayload
MUTATION	`bulkUpdateEmailLabelRelation`(input: [CreateOrUpdateEmailLabelRelationInput!]!, deleteInput: [DeleteEmailLabelRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateEmailLabelRelationPayload
MUTATION	`deleteEmailLabelRelation`(input: DeleteEmailLabelRelationInput!)	Soft-delete	DeleteEmailLabelRelationPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

EmailLabelRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Email label applied to a conversation in a mailbox.

Field	Type	Description
`isDeleteProtected`	Boolean!	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.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`emailLabel`	EmailLabelEntity	Label applied to the thread by this relation.
`owner`	ClientEntity	Sales user who owns this relation. Derived from the label's owner on write.
`emailLabelId`	ID!	Id of the applied label.
`mailboxId`	ID!	Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes.
`ownerId`	ID	Id of the relation owner.
`threadId`	ID!	Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

EmailLabelRelationEntityConnection object pageInfo: PageInfo!, edges: [EmailLabelRelationEntityEdge]!, totalCount: Int

Paginated list of EmailLabelRelation records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[EmailLabelRelationEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

EmailLabelRelationEntityEdge object node: EmailLabelRelationEntity, cursor: String!

A Relay edge containing a EmailLabelRelationEntity and its cursor.

Field	Type	Description
`node`	EmailLabelRelationEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

EmailLabelRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for EmailLabelRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[EmailLabelRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[EmailLabelRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	EmailLabelRelationFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`emailLabelId`	EntityFilterStringField	Id of the applied label.
`mailboxId`	EntityFilterStringField	Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes.
`ownerId`	EntityFilterStringField	Id of the relation owner.
`threadId`	EntityFilterStringField	Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label.
`emailLabel`	EmailLabelFilterInput	Label applied to the thread by this relation. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	Sales user who owns this relation. Derived from the label's owner on write. Matches records where a related record meets these conditions.

EmailLabelRelationOrderByInput input Asc or Desc per field

Sorting of EmailLabelRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`emailLabel`	[EmailLabelOrderByNestedInput!]	Label applied to the thread by this relation. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	Sales user who owns this relation. Derived from the label's owner on write. Sorts by fields of the related record, listed in order of priority.
`emailLabelId`	OrderByEnum	Id of the applied label.
`ownerId`	OrderByEnum	Id of the relation owner.

CreateEmailLabelRelationInput input 8 fields: clientMutationId, modified, created, …

Field values of a new EmailLabelRelation record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`emailLabel`	CreateEmailLabelInput!	Label applied to the thread by this relation.
`emailLabelId`	ID!	Id of the applied label.
`mailboxId`	ID!	Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes.
`ownerId`	ID	Id of the relation owner.
`threadId`	ID!	Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label.

CreateOrUpdateEmailLabelRelationInput input 9 fields: clientMutationId, id, modified, …

Field values of an EmailLabelRelation record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`emailLabel`	CreateEmailLabelInput	Label applied to the thread by this relation.
`emailLabelId`	ID	Id of the applied label.
`mailboxId`	ID	Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes.
`ownerId`	ID	Id of the relation owner.
`threadId`	ID	Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label.

DeleteEmailLabelRelationInput input clientMutationId: String, id: ID!

Id of the EmailLabelRelation record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateEmailLabelRelationInput input 9 fields: clientMutationId, id, modified, …

Id of an EmailLabelRelation record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`emailLabel`	CreateEmailLabelInput	Label applied to the thread by this relation.
`emailLabelId`	ID	Id of the applied label.
`mailboxId`	ID	Id of the mailbox (connected email account) the label is applied in. A label applies to a thread per mailbox, so the same thread can be labelled differently in two mailboxes.
`ownerId`	ID	Id of the relation owner.
`threadId`	ID	Identifier of the conversation thread the label is applied to, matching Email.threadId. Every email in the thread shows the label.

BulkUpdateEmailLabelRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateEmailLabelRelation mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateEmailLabelRelationPayload object emailLabelRelation: EmailLabelRelationEntity, clientMutationId: String

Result of the createEmailLabelRelation mutation.

Field	Type	Description
`emailLabelRelation`	EmailLabelRelationEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteEmailLabelRelationPayload object emailLabelRelation: EmailLabelRelationEntity, clientMutationId: String

Result of the deleteEmailLabelRelation mutation.

Field	Type	Description
`emailLabelRelation`	EmailLabelRelationEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateEmailLabelRelationPayload object emailLabelRelation: EmailLabelRelationEntity, clientMutationId: String

Result of the updateEmailLabelRelation mutation.

Field	Type	Description
`emailLabelRelation`	EmailLabelRelationEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).