--- title: entities.importMappingMask description: Read import mapping mask records with the importMappingMask repository, and change them with the import mapping mask mutations. Same records as the REST ImportMappingMasks entity. canonical: https://developers.coevera.com/reference/graphql/import-mapping-mask/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.importMappingMask Read import mapping mask records with the importMappingMask repository, and change them with the import mapping mask mutations. Same records as the REST ImportMappingMasks entity. REST: [ImportMappingMasks](https://developers.coevera.com/reference/rest/import-mapping-masks.md). ## Queries - `getById(entityId: ID!): ImportMappingMaskEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [ImportMappingMaskEntity!]!` 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: ImportMappingMaskFilterInput, orderBy: [ImportMappingMaskOrderByInput!], includeDeleted: Boolean): [ImportMappingMaskEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: ImportMappingMaskFilterInput, orderBy: [ImportMappingMaskOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ImportMappingMaskEntityConnection` 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. - `getForEntityType(entityType: ImportMaskEntityTypeEnum!, entityApiName: String): [ImportMappingMaskEntity!]!` Returns the saved import column mappings for the given record type, sorted by name. ## Mutations - `createImportMappingMask(input: CreateImportMappingMaskInput!, validationLevel: [ValidationLevel!]): CreateImportMappingMaskPayload` Create one record. - `updateImportMappingMask(input: UpdateImportMappingMaskInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateImportMappingMaskPayload` Update fields. - `bulkUpdateImportMappingMask(input: [CreateOrUpdateImportMappingMaskInput!]!, deleteInput: [DeleteImportMappingMaskInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateImportMappingMaskPayload` Create or update many; per-item results. - `deleteImportMappingMask(input: DeleteImportMappingMaskInput!): DeleteImportMappingMaskPayload` Soft-delete. ## Types ### ImportMappingMaskEntity (object) Saved mapping of import file columns to fields, reused when importing records of the same entity. - `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. - `owner: ClientEntity` User who owns the import mapping mask. - `entityApiName: String` API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). - `entityType: ImportMaskEntityTypeEnum!` Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. - `mapping: JSONString!` How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. - `name: String!` Display name of the mask. - `ownerId: ID!` Id of the owning user. - `relationTypes: JSONString` Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. - `shareMode: ProfileShareMode` Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. - `revision: Int` Revision when entity was lastly changed. - `sharingClients: [ClientEntity!]` Users granted shared access to this import mapping mask (custom share mode). - `sharingUnits: [SalesUnitEntity!]` Sales units granted shared access to this import mapping mask (custom share mode). - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. - `mappingMask: [ImportMappingMaskItem!]` How the columns of the import file map to fields: one item per mapped field, with the mapping type and the source column. - `mappingRelationTypes: [ImportMappingRelationType!]` Record type selected for each mapped relation field of the mask. - `isDefault: Boolean!` True for a default import mapping mask provided by Coevera; it cannot be deleted. ### ImportMappingMaskEntityConnection (object) Paginated list of ImportMappingMask records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [ImportMappingMaskEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### ImportMappingMaskEntityEdge (object) A Relay edge containing a `ImportMappingMaskEntity` and its cursor. - `node: ImportMappingMaskEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### ImportMappingMaskFilterInput (input) Filter conditions for ImportMappingMask records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [ImportMappingMaskFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [ImportMappingMaskFilterInput!]` Matches records that meet all of the listed filters. - `NOT: ImportMappingMaskFilterInput` 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. - `entityApiName: EntityFilterStringField` API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). - `entityType: ImportMaskEntityTypeEnumFilterInput` Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. - `name: EntityFilterStringField` Display name of the mask. - `ownerId: EntityFilterStringField` Id of the owning user. - `shareMode: ShareModeEnumFilterInput` Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `owner: ClientFilterInput` User who owns the import mapping mask. Matches records where a related record meets these conditions. ### ImportMappingMaskOrderByInput (input) Sorting of ImportMappingMask 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. - `owner: [ClientOrderByNestedInput!]` User who owns the import mapping mask. Sorts by fields of the related record, listed in order of priority. - `entityApiName: OrderByEnum` API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). - `ownerId: OrderByEnum` Id of the owning user. - `shareMode: OrderByEnum` Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. - `revision: OrderByEnum` Revision when entity was lastly changed. ### ImportMaskEntityTypeEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [ImportMaskEntityTypeEnum!]` Matches any of the listed values. - `NOT: ImportMaskEntityTypeEnumFilterInput` Matches values that do not meet this condition. ### CreateImportMappingMaskInput (input) Field values of a new ImportMappingMask 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. - `entityApiName: String` API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). - `entityType: ImportMaskEntityTypeEnum!` Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. - `mapping: JSONString!` How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. - `name: String!` Display name of the mask. - `ownerId: ID!` Id of the owning user. - `relationTypes: JSONString` Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. - `shareMode: ProfileShareMode` Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. - `revision: Int` Revision when entity was lastly changed. - `sharingClients: [UUID!]` Users granted shared access to this import mapping mask (custom share mode). - `sharingUnits: [UUID!]` Sales units granted shared access to this import mapping mask (custom share mode). ### CreateOrUpdateImportMappingMaskInput (input) Field values of an ImportMappingMask 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. - `entityApiName: String` API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). - `entityType: ImportMaskEntityTypeEnum` Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. - `mapping: JSONString` How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. - `name: String` Display name of the mask. - `ownerId: ID` Id of the owning user. - `relationTypes: JSONString` Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. - `shareMode: ProfileShareMode` Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. - `revision: Int` Revision when entity was lastly changed. - `sharingClients: [UUID!]` Users granted shared access to this import mapping mask (custom share mode). - `sharingUnits: [UUID!]` Sales units granted shared access to this import mapping mask (custom share mode). ### DeleteImportMappingMaskInput (input) Id of the ImportMappingMask 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. ### UpdateImportMappingMaskInput (input) Id of an ImportMappingMask 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. - `entityApiName: String` API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name). - `entityType: ImportMaskEntityTypeEnum` Entity the mask imports records into, such as leads, accounts, users or product prices. For custom entities, entityApiName identifies the custom entity. - `mapping: JSONString` How the import file fills each field, as a JSON array of objects conforming to the `ImportMappingMaskItem` type: field_id, mapping_type (ColumnIndex, UseDefaultValues or CalculateValue) and, for ColumnIndex, column_index. Validated on write. - `name: String` Display name of the mask. - `ownerId: ID` Id of the owning user. - `relationTypes: JSONString` Record type selected for each mapped relation field, as a JSON array of objects conforming to the `ImportMappingRelationType` type, each with field_id and entity_type_id. Validated on write. - `shareMode: ProfileShareMode` Who besides the owner can use the import mapping mask: nobody (Private, the default), the users and sales units in sharingClients and sharingUnits, or all users. - `revision: Int` Revision when entity was lastly changed. - `sharingClients: [UUID!]` Users granted shared access to this import mapping mask (custom share mode). - `sharingUnits: [UUID!]` Sales units granted shared access to this import mapping mask (custom share mode). ### BulkUpdateImportMappingMaskPayload (object) Result of the bulkUpdateImportMappingMask mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateImportMappingMaskPayload (object) Result of the createImportMappingMask mutation. - `importMappingMask: ImportMappingMaskEntity` 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). ### DeleteImportMappingMaskPayload (object) Result of the deleteImportMappingMask mutation. - `importMappingMask: ImportMappingMaskEntity` 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). ### UpdateImportMappingMaskPayload (object) Result of the updateImportMappingMask mutation. - `importMappingMask: ImportMappingMaskEntity` 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). ### ImportFieldMappingType (enum) How an import mapping fills a target field. - `ColumnIndex` Value is read from the file column given by columnIndex. - `UseDefaultValues` The field's default value is used. - `CalculateValue` The value is calculated by Coevera instead of imported. ### ImportMappingMaskItem (object) How a saved import mapping fills one field: the mapping type and the source column of the import file. - `fieldId: ID!` Id of the field the import fills. - `mappingType: ImportFieldMappingType!` How the import fills the field. - `columnIndex: Int` Index of the import file column the value is read from; set when mappingType is ColumnIndex. ### ImportMappingRelationType (object) Record type selected for a relation field in a saved import mapping. - `fieldId: ID!` Id of the mapped relation field. - `entityTypeId: ID!` Id of the record type selected for the relation field. ### ImportMaskEntityTypeEnum (enum) Entity that an import mapping mask imports records into. - `Lead` Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost. - `Opportunity` Potential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost. - `Account` Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. - `Contact` Person the sales team works with, usually linked to one or more accounts, leads and opportunities. - `Client` Users of the space. - `Product` Product or service in the catalog that can be added as a line item to opportunities and quotes. - `ProductPriceListPrice` Product prices in price lists. - `CustomEntity` Record of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities. ### ProfileShareMode (enum) Who besides the owner can use a shared item such as an import mapping. - `Private` Only the owner. - `Public` All users. - `SelectedUnitsAndUsers` The users and sales units the item is shared with. 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 FirstImportMappingMasks { entities { importMappingMask { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name 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 FirstImportMappingMasks { entities { importMappingMask { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}' ```