---
title: entities.onlineFormTypeEmailRelation
description: Read online form type email relation records with the onlineFormTypeEmailRelation repository, and change them with the online form type email relation mutations. Same records as the REST OnlineFormTypeEmailRelations entity.
canonical: https://developers.coevera.com/reference/graphql/online-form-type-email-relation/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.onlineFormTypeEmailRelation

Read online form type email relation records with the onlineFormTypeEmailRelation repository, and change them with the online form type email relation mutations. Same records as the REST OnlineFormTypeEmailRelations entity.

REST: [OnlineFormTypeEmailRelations](https://developers.coevera.com/reference/rest/online-form-type-email-relations.md).

## Queries

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

## Mutations

- `createOnlineFormTypeEmailRelation(input: CreateOnlineFormTypeEmailRelationInput!, validationLevel: [ValidationLevel!]): CreateOnlineFormTypeEmailRelationPayload` Create one record.
- `updateOnlineFormTypeEmailRelation(input: UpdateOnlineFormTypeEmailRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateOnlineFormTypeEmailRelationPayload` Update fields.
- `bulkUpdateOnlineFormTypeEmailRelation(input: [CreateOrUpdateOnlineFormTypeEmailRelationInput!]!, deleteInput: [DeleteOnlineFormTypeEmailRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateOnlineFormTypeEmailRelationPayload` Create or update many; per-item results.
- `deleteOnlineFormTypeEmailRelation(input: DeleteOnlineFormTypeEmailRelationInput!): DeleteOnlineFormTypeEmailRelationPayload` Soft-delete.

## Types

### OnlineFormTypeEmailRelationEntity (object)

Email that sent an online form link to a recipient, with the record it was sent on.

- `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 the email recipient belongs to, when applicable.
- `contact: ContactEntity` Contact the email was addressed to, when applicable.
- `customEntity: CustomEntityEntity` Custom entity record the form was sent on, when applicable.
- `email: EmailEntity` Email message used to deliver the form link to the recipient.
- `lead: LeadEntity` Lead the form was sent on. Set when leadOpptyId resolves to a Lead.
- `oppty: OpportunityEntity` Opportunity the form was sent on. Set when leadOpptyId resolves to an Opportunity.
- `onlineFormType: OnlineFormTypeEntity` Online form being shared with the recipient via email.
- `quote: QuoteEntity` Quote the form was sent on, when applicable.
- `accountId: ID` Id of the linked account.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `emailId: ID!` Id of the email message.
- `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not linked.
- `onlineFormTypeId: ID!` Id of the online form whose link the email delivers to the recipient.
- `quoteId: ID` Id of the linked quote.
- `revision: Int` Revision when entity was lastly changed.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### OnlineFormTypeEmailRelationEntityConnection (object)

Paginated list of OnlineFormTypeEmailRelation records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [OnlineFormTypeEmailRelationEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### OnlineFormTypeEmailRelationEntityEdge (object)

A Relay edge containing a `OnlineFormTypeEmailRelationEntity` and its cursor.

- `node: OnlineFormTypeEmailRelationEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### OnlineFormTypeEmailRelationFilterInput (input)

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

- `OR: [OnlineFormTypeEmailRelationFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [OnlineFormTypeEmailRelationFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: OnlineFormTypeEmailRelationFilterInput` 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 linked account.
- `contactId: EntityFilterStringField` Id of the linked contact.
- `customEntityId: EntityFilterStringField` Id of the linked custom entity record.
- `emailId: EntityFilterStringField` Id of the email message.
- `leadOpptyId: EntityFilterStringField` Id of the linked lead or opportunity, or empty when not linked.
- `onlineFormTypeId: EntityFilterStringField` Id of the online form whose link the email delivers to the recipient.
- `quoteId: EntityFilterStringField` Id of the linked quote.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `account: AccountFilterInput` Account the email recipient belongs to, when applicable. Matches records where a related record meets these conditions.
- `contact: ContactFilterInput` Contact the email was addressed to, when applicable. Matches records where a related record meets these conditions.
- `customEntity: CustomEntityFilterInput` Custom entity record the form was sent on, when applicable. Matches records where a related record meets these conditions.
- `email: EmailFilterInput` Email message used to deliver the form link to the recipient. Matches records where a related record meets these conditions.
- `lead: LeadFilterInput` Lead the form was sent on. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions.
- `oppty: OpportunityFilterInput` Opportunity the form was sent on. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions.
- `onlineFormType: OnlineFormTypeFilterInput` Online form being shared with the recipient via email. Matches records where a related record meets these conditions.
- `quote: QuoteFilterInput` Quote the form was sent on, when applicable. Matches records where a related record meets these conditions.

### OnlineFormTypeEmailRelationOrderByInput (input)

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

- `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 the email recipient belongs to, when applicable. Sorts by fields of the related record, listed in order of priority.
- `contact: [ContactOrderByNestedInput!]` Contact the email was addressed to, when applicable. Sorts by fields of the related record, listed in order of priority.
- `customEntity: [CustomEntityOrderByNestedInput!]` Custom entity record the form was sent on, when applicable. Sorts by fields of the related record, listed in order of priority.
- `email: [EmailOrderByNestedInput!]` Email message used to deliver the form link to the recipient. Sorts by fields of the related record, listed in order of priority.
- `lead: [LeadOrderByNestedInput!]` Lead the form was sent on. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority.
- `oppty: [OpportunityOrderByNestedInput!]` Opportunity the form was sent on. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority.
- `onlineFormType: [OnlineFormTypeOrderByNestedInput!]` Online form being shared with the recipient via email. Sorts by fields of the related record, listed in order of priority.
- `quote: [QuoteOrderByNestedInput!]` Quote the form was sent on, when applicable. Sorts by fields of the related record, listed in order of priority.
- `accountId: OrderByEnum` Id of the linked account.
- `contactId: OrderByEnum` Id of the linked contact.
- `customEntityId: OrderByEnum` Id of the linked custom entity record.
- `emailId: OrderByEnum` Id of the email message.
- `leadOpptyId: OrderByEnum` Id of the linked lead or opportunity, or empty when not linked.
- `onlineFormTypeId: OrderByEnum` Id of the online form whose link the email delivers to the recipient.
- `quoteId: OrderByEnum` Id of the linked quote.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateOnlineFormTypeEmailRelationInput (input)

Field values of a new OnlineFormTypeEmailRelation 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).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `accountId: ID` Id of the linked account.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `emailId: ID!` Id of the email message.
- `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not linked.
- `onlineFormTypeId: ID!` Id of the online form whose link the email delivers to the recipient.
- `quoteId: ID` Id of the linked quote.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateOnlineFormTypeEmailRelationInput (input)

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

- `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 linked account.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `emailId: ID` Id of the email message.
- `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not linked.
- `onlineFormTypeId: ID` Id of the online form whose link the email delivers to the recipient.
- `quoteId: ID` Id of the linked quote.
- `revision: Int` Revision when entity was lastly changed.

### DeleteOnlineFormTypeEmailRelationInput (input)

Id of the OnlineFormTypeEmailRelation record to delete.

- `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.
- `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not linked.

### UpdateOnlineFormTypeEmailRelationInput (input)

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

- `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 linked account.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `emailId: ID` Id of the email message.
- `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not linked.
- `onlineFormTypeId: ID` Id of the online form whose link the email delivers to the recipient.
- `quoteId: ID` Id of the linked quote.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateOnlineFormTypeEmailRelationPayload (object)

Result of the bulkUpdateOnlineFormTypeEmailRelation mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateOnlineFormTypeEmailRelationPayload (object)

Result of the createOnlineFormTypeEmailRelation mutation.

- `onlineFormTypeEmailRelation: OnlineFormTypeEmailRelationEntity` 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).

### DeleteOnlineFormTypeEmailRelationPayload (object)

Result of the deleteOnlineFormTypeEmailRelation mutation.

- `onlineFormTypeEmailRelation: OnlineFormTypeEmailRelationEntity` 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).

### UpdateOnlineFormTypeEmailRelationPayload (object)

Result of the updateOnlineFormTypeEmailRelation mutation.

- `onlineFormTypeEmailRelation: OnlineFormTypeEmailRelationEntity` 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).

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstOnlineFormTypeEmailRelations {
  entities {
    onlineFormTypeEmailRelation {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}
```

```bash
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 FirstOnlineFormTypeEmailRelations { entities { onlineFormTypeEmailRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'
```
