GraphQL RepositoriesemailSequenceEnrolled

`entities.emailSequenceEnrolled`

Read email sequence enrolled records with the emailSequenceEnrolled repository, and change them with the email sequence enrolled mutations. Same records as the REST EmailSequenceEnrolleds entity.

Example: first three email sequence enrolled recordsGraphQLcURL

query FirstEmailSequenceEnrolleds {
  entities {
    emailSequenceEnrolled {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name 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 FirstEmailSequenceEnrolleds { entities { emailSequenceEnrolled { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { emailSequenceEnrolled { … } }.

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.	EmailSequenceEnrolledEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[EmailSequenceEnrolledEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: EmailSequenceEnrolledFilterInput, orderBy: [EmailSequenceEnrolledOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[EmailSequenceEnrolledEntity!]!
QUERY	`getByCriteria`(filter: EmailSequenceEnrolledFilterInput, orderBy: [EmailSequenceEnrolledOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	EmailSequenceEnrolledEntityConnection
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!]!
QUERY	`getEnrolledEmailSequences`(entityId: UUID!, limit: Int) Returns the email sequence enrollments of a record, one per sequence, with the most recently updated first.	[EmailSequenceEnrolledEntity!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createEmailSequenceEnrolled`(input: CreateEmailSequenceEnrolledInput!, validationLevel: [ValidationLevel!])	Create one record	CreateEmailSequenceEnrolledPayload
MUTATION	`updateEmailSequenceEnrolled`(input: UpdateEmailSequenceEnrolledInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateEmailSequenceEnrolledPayload
MUTATION	`bulkUpdateEmailSequenceEnrolled`(input: [CreateOrUpdateEmailSequenceEnrolledInput!]!, deleteInput: [DeleteEmailSequenceEnrolledInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateEmailSequenceEnrolledPayload
MUTATION	`deleteEmailSequenceEnrolled`(input: DeleteEmailSequenceEnrolledInput!)	Soft-delete	DeleteEmailSequenceEnrolledPayload

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.

EmailSequenceEnrolledEntity object 36 fields: isDeleteProtected, id, isDeleted, …

Record enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it.

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.
`account`	AccountEntity	Account that was enrolled, when the trigger entity is an Account; otherwise empty.
`actor`	ClientEntity	User who triggered the enrolment, or empty for runs triggered by automation.
`application`	ApplicationEntity	Application context the enrolment was triggered in.
`contact`	ContactEntity	Contact that was enrolled, when the trigger entity is a Contact; otherwise empty.
`emailSequenceActivityLog`	EmailSequenceActivityLogEntity	Activity log run that produced this enrolment.
`emailSequence`	EmailSequenceEntity	Email sequence this enrolment belongs to.
`lead`	LeadEntity	Lead that was enrolled, when the trigger entity is a Lead; otherwise empty.
`oppty`	OpportunityEntity	Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty.
`project`	ProjectEntity	Project that was enrolled, when the trigger entity is a Project; otherwise empty.
`accountId`	ID	Id of the enrolled account.
`actorId`	ID	Id of the user who triggered the enrolment, or empty for runs triggered by automation.
`applicationId`	ID!	Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in.
`contactId`	ID	Id of the enrolled contact.
`emailSequenceActivityLogId`	ID!	Id of the activity log run that produced this enrolment.
`emailSequenceId`	ID!	Id of the email sequence this enrolment belongs to.
`endReason`	EmailSequenceEndReasonEnum	Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active.
`endTime`	DateTime	Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active.
`entityId`	ID!	Id of the enrolled record: the account, contact, lead, opportunity or project that is set. Read-only.
`entityType`	BaseEntityTypeEnum!	Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only.
`excludedFromStats`	Boolean	True when this enrolment is excluded from sequence statistics (e.g. after a stats reset).
`leadId`	ID	Id of the enrolled lead.
`opptyId`	ID	Id of the enrolled opportunity.
`projectId`	ID	Id of the enrolled project.
`startTime`	DateTime!	Timestamp when the enrolment started.
`stepCount`	Int!	Number of steps the enrolment has reached. Read-only.
`name`	String	Display name of the enrolled record, formatted according to the calling user's preferred name format. Empty when the underlying record has been deleted.
`address`	String	Email address used for delivery of this enrolment.
`stepIndex`	Int	Zero-based index of the next step the enrolment will execute (i.e. one past the highest stepIndex recorded in EmailSequenceEnrolledStatus). Empty before the first step runs.
`status`	ProcessStatusEnum	Status of the enrolment's most recent sequence run (e.g. Ok, Warning, Error). Empty before the first run.
`entityName`	EntityNameEnum!	Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entityType.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

EmailSequenceEnrolledEntityConnection object pageInfo: PageInfo!, edges: [EmailSequenceEnrolledEntityEdge]!, totalCount: Int

Paginated list of EmailSequenceEnrolled records.

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

EmailSequenceEnrolledEntityEdge object node: EmailSequenceEnrolledEntity, cursor: String!

A Relay edge containing a EmailSequenceEnrolledEntity and its cursor.

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

EmailSequenceEndReasonEnumFilterInput input eq: [EmailSequenceEndReasonEnum!], NOT: EmailSequenceEndReasonEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[EmailSequenceEndReasonEnum!]	Matches any of the listed values.
`NOT`	EmailSequenceEndReasonEnumFilterInput	Matches values that do not meet this condition.

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

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

Input field	Type	Description
`OR`	[EmailSequenceEnrolledFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[EmailSequenceEnrolledFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	EmailSequenceEnrolledFilterInput	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.
`accountId`	EntityFilterStringField	Id of the enrolled account.
`actorId`	EntityFilterStringField	Id of the user who triggered the enrolment, or empty for runs triggered by automation.
`applicationId`	EntityFilterStringField	Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in.
`contactId`	EntityFilterStringField	Id of the enrolled contact.
`emailSequenceActivityLogId`	EntityFilterStringField	Id of the activity log run that produced this enrolment.
`emailSequenceId`	EntityFilterStringField	Id of the email sequence this enrolment belongs to.
`endReason`	EmailSequenceEndReasonEnumFilterInput	Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active.
`endTime`	EntityFilterDateTimeField	Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active.
`entityId`	EntityFilterStringField	Id of the enrolled record: the account, contact, lead, opportunity or project that is set. Read-only.
`entityType`	BaseEntityTypeEnumFilterInput	Type of the enrolled entity (e.g. Account, Contact, Lead). Read-only.
`excludedFromStats`	Boolean	True when this enrolment is excluded from sequence statistics (e.g. after a stats reset).
`leadId`	EntityFilterStringField	Id of the enrolled lead.
`opptyId`	EntityFilterStringField	Id of the enrolled opportunity.
`projectId`	EntityFilterStringField	Id of the enrolled project.
`startTime`	EntityFilterDateTimeField	Timestamp when the enrolment started.
`stepCount`	EntityFilterNumberField	Number of steps the enrolment has reached. Read-only.
`name`	EntityFilterStringField	Display name of the enrolled record, formatted according to the calling user's preferred name format. Empty when the underlying record has been deleted.
`address`	EntityFilterStringField	Email address used for delivery of this enrolment.
`stepIndex`	Int	Zero-based index of the next step the enrolment will execute (i.e. one past the highest stepIndex recorded in EmailSequenceEnrolledStatus). Empty before the first step runs.
`status`	ProcessStatusEnum	Status of the enrolment's most recent sequence run (e.g. Ok, Warning, Error). Empty before the first run.
`entityName`	EntityNameEnum	Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entityType.
`account`	AccountFilterInput	Account that was enrolled, when the trigger entity is an Account; otherwise empty. Matches records where a related record meets these conditions.
`actor`	ClientFilterInput	User who triggered the enrolment, or empty for runs triggered by automation. Matches records where a related record meets these conditions.
`application`	ApplicationFilterInput	Application context the enrolment was triggered in. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Contact that was enrolled, when the trigger entity is a Contact; otherwise empty. Matches records where a related record meets these conditions.
`emailSequenceActivityLog`	EmailSequenceActivityLogFilterInput	Activity log run that produced this enrolment. Matches records where a related record meets these conditions.
`emailSequence`	EmailSequenceFilterInput	Email sequence this enrolment belongs to. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead that was enrolled, when the trigger entity is a Lead; otherwise empty. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty. Matches records where a related record meets these conditions.
`project`	ProjectFilterInput	Project that was enrolled, when the trigger entity is a Project; otherwise empty. Matches records where a related record meets these conditions.

EmailSequenceEnrolledOrderByInput input Asc or Desc per field

Sorting of EmailSequenceEnrolled 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.
`account`	[AccountOrderByNestedInput!]	Account that was enrolled, when the trigger entity is an Account; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`actor`	[ClientOrderByNestedInput!]	User who triggered the enrolment, or empty for runs triggered by automation. Sorts by fields of the related record, listed in order of priority.
`application`	[ApplicationOrderByNestedInput!]	Application context the enrolment was triggered in. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Contact that was enrolled, when the trigger entity is a Contact; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`emailSequenceActivityLog`	[EmailSequenceActivityLogOrderByNestedInput!]	Activity log run that produced this enrolment. Sorts by fields of the related record, listed in order of priority.
`emailSequence`	[EmailSequenceOrderByNestedInput!]	Email sequence this enrolment belongs to. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead that was enrolled, when the trigger entity is a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity that was enrolled, when the trigger entity is an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`project`	[ProjectOrderByNestedInput!]	Project that was enrolled, when the trigger entity is a Project; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`accountId`	OrderByEnum	Id of the enrolled account.
`actorId`	OrderByEnum	Id of the user who triggered the enrolment, or empty for runs triggered by automation.
`applicationId`	OrderByEnum	Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in.
`contactId`	OrderByEnum	Id of the enrolled contact.
`emailSequenceActivityLogId`	OrderByEnum	Id of the activity log run that produced this enrolment.
`emailSequenceId`	OrderByEnum	Id of the email sequence this enrolment belongs to.
`endReason`	OrderByEnum	Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active.
`endTime`	OrderByEnum	Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active.
`excludedFromStats`	OrderByEnum	True when this enrolment is excluded from sequence statistics (e.g. after a stats reset).
`leadId`	OrderByEnum	Id of the enrolled lead.
`opptyId`	OrderByEnum	Id of the enrolled opportunity.
`projectId`	OrderByEnum	Id of the enrolled project.
`startTime`	OrderByEnum	Timestamp when the enrolment started.
`stepCount`	OrderByEnum	Number of steps the enrolment has reached. Read-only.
`name`	OrderByEnum	Display name of the enrolled record, formatted according to the calling user's preferred name format. Empty when the underlying record has been deleted.
`address`	OrderByEnum	Email address used for delivery of this enrolment.
`stepIndex`	OrderByEnum	Zero-based index of the next step the enrolment will execute (i.e. one past the highest stepIndex recorded in EmailSequenceEnrolledStatus). Empty before the first step runs.
`status`	OrderByEnum	Status of the enrolment's most recent sequence run (e.g. Ok, Warning, Error). Empty before the first run.
`entityName`	OrderByEnum	Name of the enrolled entity (Account, Contact, Lead, Opportunity, or Project), derived from entityType.

CreateEmailSequenceEnrolledInput input 16 fields: clientMutationId, modified, created, …

Field values of a new EmailSequenceEnrolled 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.
`accountId`	ID	Id of the enrolled account.
`actorId`	ID	Id of the user who triggered the enrolment, or empty for runs triggered by automation.
`applicationId`	ID!	Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in.
`contactId`	ID	Id of the enrolled contact.
`emailSequenceActivityLogId`	ID!	Id of the activity log run that produced this enrolment.
`emailSequenceId`	ID!	Id of the email sequence this enrolment belongs to.
`endReason`	EmailSequenceEndReasonEnum	Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active.
`endTime`	DateTime	Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active.
`excludedFromStats`	Boolean	True when this enrolment is excluded from sequence statistics (e.g. after a stats reset).
`leadId`	ID	Id of the enrolled lead.
`opptyId`	ID	Id of the enrolled opportunity.
`projectId`	ID	Id of the enrolled project.
`startTime`	DateTime!	Timestamp when the enrolment started.

CreateOrUpdateEmailSequenceEnrolledInput input 17 fields: clientMutationId, id, modified, …

Field values of an EmailSequenceEnrolled 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.
`accountId`	ID	Id of the enrolled account.
`actorId`	ID	Id of the user who triggered the enrolment, or empty for runs triggered by automation.
`applicationId`	ID	Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in.
`contactId`	ID	Id of the enrolled contact.
`emailSequenceActivityLogId`	ID	Id of the activity log run that produced this enrolment.
`emailSequenceId`	ID	Id of the email sequence this enrolment belongs to.
`endReason`	EmailSequenceEndReasonEnum	Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active.
`endTime`	DateTime	Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active.
`excludedFromStats`	Boolean	True when this enrolment is excluded from sequence statistics (e.g. after a stats reset).
`leadId`	ID	Id of the enrolled lead.
`opptyId`	ID	Id of the enrolled opportunity.
`projectId`	ID	Id of the enrolled project.
`startTime`	DateTime	Timestamp when the enrolment started.

DeleteEmailSequenceEnrolledInput input clientMutationId: String, id: ID!

Id of the EmailSequenceEnrolled 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.

UpdateEmailSequenceEnrolledInput input 17 fields: clientMutationId, id, modified, …

Id of an EmailSequenceEnrolled 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.
`accountId`	ID	Id of the enrolled account.
`actorId`	ID	Id of the user who triggered the enrolment, or empty for runs triggered by automation.
`applicationId`	ID	Id of the application (e.g. browser, automation, third-party integration) the enrolment was triggered in.
`contactId`	ID	Id of the enrolled contact.
`emailSequenceActivityLogId`	ID	Id of the activity log run that produced this enrolment.
`emailSequenceId`	ID	Id of the email sequence this enrolment belongs to.
`endReason`	EmailSequenceEndReasonEnum	Why the enrolment ended: Finished after all steps, Unenrolled when the record was removed before finishing, or NoReason while the enrolment is still active.
`endTime`	DateTime	Timestamp when the enrolment ended (completed or unenrolled). Empty while the enrolment is active.
`excludedFromStats`	Boolean	True when this enrolment is excluded from sequence statistics (e.g. after a stats reset).
`leadId`	ID	Id of the enrolled lead.
`opptyId`	ID	Id of the enrolled opportunity.
`projectId`	ID	Id of the enrolled project.
`startTime`	DateTime	Timestamp when the enrolment started.

BulkUpdateEmailSequenceEnrolledPayload object result: BulkUpdateResults!

Result of the bulkUpdateEmailSequenceEnrolled mutation.

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

CreateEmailSequenceEnrolledPayload object emailSequenceEnrolled: EmailSequenceEnrolledEntity, clientMutationId: String

Result of the createEmailSequenceEnrolled mutation.

Field	Type	Description
`emailSequenceEnrolled`	EmailSequenceEnrolledEntity	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).

DeleteEmailSequenceEnrolledPayload object emailSequenceEnrolled: EmailSequenceEnrolledEntity, clientMutationId: String

Result of the deleteEmailSequenceEnrolled mutation.

Field	Type	Description
`emailSequenceEnrolled`	EmailSequenceEnrolledEntity	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).

UpdateEmailSequenceEnrolledPayload object emailSequenceEnrolled: EmailSequenceEnrolledEntity, clientMutationId: String

Result of the updateEmailSequenceEnrolled mutation.

Field	Type	Description
`emailSequenceEnrolled`	EmailSequenceEnrolledEntity	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).

EmailSequenceEndReasonEnum enum NoReason, Unenrolled, Finished

Why a record's enrollment in an email sequence ended.

Value	Description
`NoReason`	The enrollment has not ended; the record is still in the sequence.
`Unenrolled`	The record was removed before finishing, for example manually, by a process, by a step condition or because the sequence expired.
`Finished`	The record went through all steps of the sequence.