GraphQL Repositorieslead

`entities.lead`

Read lead records with the lead repository, and change them with the lead mutations. Same records as the REST Leads entity.

9 queries
21 mutations
REST: Leads

Example: first three lead recordsGraphQLcURL

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

Queries

Fields of entities { lead { … } }.

Each operation opens an example built from the schema and checked against it on every build. Replace the placeholders, such as <lead id>, with values from your space.

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.	LeadEntity
Example Example: getByIdGraphQLcURL `query LeadGetById { entities { lead { getById(entityId: "<lead id>") { id name formattedName 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 LeadGetById { entities { lead { getById(entityId: \"<lead id>\") { id name formattedName modified } } } }"}'`
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[LeadEntity!]!
Example Example: getByIdsGraphQLcURL `query LeadGetByIds { entities { lead { getByIds(entityIds: ["<lead id>"]) { id name formattedName 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 LeadGetByIds { entities { lead { getByIds(entityIds: [\"<lead id>\"]) { id name formattedName modified } } } }"}'`
QUERY	`getAll`(limit: Int, offset: Int, filter: LeadFilterInput, orderBy: [LeadOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[LeadEntity!]!
Example Example: getAllGraphQLcURL `query LeadGetAll { entities { lead { getAll(limit: 10) { id name formattedName 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 LeadGetAll { entities { lead { getAll(limit: 10) { id name formattedName modified } } } }"}'`
QUERY	`getByCriteria`(filter: LeadFilterInput, orderBy: [LeadOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	LeadEntityConnection
Example Example: getByCriteriaGraphQLcURL `query LeadGetByCriteria { entities { lead { getByCriteria(first: 10) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } }` `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 LeadGetByCriteria { entities { lead { getByCriteria(first: 10) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } }"}'`
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!]!
Example Example: getChangedFieldsSinceRevisionGraphQLcURL `query LeadGetChangedFieldsSinceRevision { entities { lead { getChangedFieldsSinceRevision(id: "<lead id>", revision: 10) } } }` `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 LeadGetChangedFieldsSinceRevision { entities { lead { getChangedFieldsSinceRevision(id: \"<lead id>\", revision: 10) } } }"}'`
QUERY	`getBySession`(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int) Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.	LeadEntityConnection
Example Example: getBySessionGraphQLcURL `query LeadGetBySession { entities { lead { getBySession( includedIds: ["<lead id>"] excludedIds: ["<lead id>"] sessionId: "<session id>" first: 10 ) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } }` `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 LeadGetBySession { entities { lead { getBySession( includedIds: [\"<lead id>\"] excludedIds: [\"<lead id>\"] sessionId: \"<session id>\" first: 10 ) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } }"}'`
QUERY	`getByIdFormatted`(id: UUID!, fieldIds: [UUID!]) Returns the values of a record's fields formatted for display, keyed by field id.	JSONString
Example Example: getByIdFormattedGraphQLcURL `query LeadGetByIdFormatted { entities { lead { getByIdFormatted(id: "<lead id>") } } }` `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 LeadGetByIdFormatted { entities { lead { getByIdFormatted(id: \"<lead id>\") } } }"}'`
QUERY	`autoPrefill`(mappingId: UUID!, entityId: UUID!, targetEntityTypeId: UUID) Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create.	LeadEntity!
Example Example: autoPrefillGraphQLcURL `query LeadAutoPrefill { entities { lead { autoPrefill(mappingId: "<mapping id>", entityId: "<lead id>") { id name formattedName 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 LeadAutoPrefill { entities { lead { autoPrefill(mappingId: \"<mapping id>\", entityId: \"<lead id>\") { id name formattedName modified } } } }"}'`
QUERY	`aiAutoPrefill`(actionId: String!) Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in.	LeadAutoPrefill!
Example Example: aiAutoPrefillGraphQLcURL `query LeadAiAutoPrefill { entities { lead { aiAutoPrefill(actionId: "<action id>") { entity { id name formattedName modified } fieldIds } } } }` `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 LeadAiAutoPrefill { entities { lead { aiAutoPrefill(actionId: \"<action id>\") { entity { id name formattedName modified } fieldIds } } } }"}'`

Mutations

Kind	Mutation	Does	Returns
MUTATION	`releaseOwnershipLead`(input: ReleaseOwnershipLeadInput!)	Release ownership GraphQL only	ReleaseOwnershipLeadPayload
Example Example: releaseOwnershipLeadGraphQLcURL `mutation ReleaseOwnershipLead { releaseOwnershipLead(input: {id: "<lead id>"}) { result { id name formattedName 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":"mutation ReleaseOwnershipLead { releaseOwnershipLead(input: {id: \"<lead id>\"}) { result { id name formattedName modified } } }"}'`
MUTATION	`changeOwnershipLead`(input: ChangeOwnershipLeadInput!)	Change owner GraphQL only	ChangeOwnershipLeadPayload
Example Example: changeOwnershipLeadGraphQLcURL `mutation ChangeOwnershipLead { changeOwnershipLead( input: {ownerId: "<owner id>", unitId: "<unit id>", keepOwnerAsEditor: false, transferLinkedRecords: false, id: "<lead id>"} ) { result { id name formattedName 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":"mutation ChangeOwnershipLead { changeOwnershipLead( input: {ownerId: \"<owner id>\", unitId: \"<unit id>\", keepOwnerAsEditor: false, transferLinkedRecords: false, id: \"<lead id>\"} ) { result { id name formattedName modified } } }"}'`
MUTATION	`manageSharingLead`(input: ManageSharingLeadInput!)	Change who it is shared with GraphQL only	ManageSharingLeadPayload
Example Example: manageSharingLeadGraphQLcURL `mutation ManageSharingLead { manageSharingLead(input: {shareMode: Standard, id: "<lead id>"}) { result { id name formattedName 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":"mutation ManageSharingLead { manageSharingLead(input: {shareMode: Standard, id: \"<lead id>\"}) { result { id name formattedName modified } } }"}'`
MUTATION	`changeLabelFlagLead`(input: ChangeLabelFlagLeadInput!)	Change the label flag GraphQL only	ChangeLabelFlagLeadPayload
Example Example: changeLabelFlagLeadGraphQLcURL `mutation ChangeLabelFlagLead { changeLabelFlagLead( input: {hot: false, priority: false, stalled: false, id: "<lead id>"} ) { result { id name formattedName 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":"mutation ChangeLabelFlagLead { changeLabelFlagLead( input: {hot: false, priority: false, stalled: false, id: \"<lead id>\"} ) { result { id name formattedName modified } } }"}'`
MUTATION	`restoreLead`(input: RestoreLeadInput!)	Restore a deleted record	RestoreLeadPayload
Example Example: restoreLeadGraphQLcURL `mutation RestoreLead { restoreLead(input: {id: "<lead id>"}) { result { id name formattedName 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":"mutation RestoreLead { restoreLead(input: {id: \"<lead id>\"}) { result { id name formattedName modified } } }"}'`
MUTATION	`copyLead`(input: CopyLeadInput!)	Copy a record GraphQL only	CopyLeadPayload
Example Example: copyLeadGraphQLcURL `mutation CopyLead { copyLead(input: {id: "<lead id>"}) { result { id name formattedName 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":"mutation CopyLead { copyLead(input: {id: \"<lead id>\"}) { result { id name formattedName modified } } }"}'`
MUTATION	`archiveLead`(input: ArchiveLeadInput!)	Archive GraphQL only	ArchiveLeadPayload
Example Example: archiveLeadGraphQLcURL `mutation ArchiveLead { archiveLead(input: {id: "<lead id>"}) { result { id name formattedName 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":"mutation ArchiveLead { archiveLead(input: {id: \"<lead id>\"}) { result { id name formattedName modified } } }"}'`
MUTATION	`reactivateLead`(input: ReactivateLeadInput!)	Undo archive GraphQL only	ReactivateLeadPayload
Example Example: reactivateLeadGraphQLcURL `mutation ReactivateLead { reactivateLead(input: {id: "<lead id>"}) { result { id name formattedName 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":"mutation ReactivateLead { reactivateLead(input: {id: \"<lead id>\"}) { result { id name formattedName modified } } }"}'`
MUTATION	`qualifyLead`(input: QualifyLeadInput!)	Qualify into an opportunity GraphQL only	QualifyLeadPayload
Example Example: qualifyLeadGraphQLcURL `mutation QualifyLead { qualifyLead(input: {entity: {id: "<lead id>"}}) { result { id name formattedName 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":"mutation QualifyLead { qualifyLead(input: {entity: {id: \"<lead id>\"}}) { result { id name formattedName modified } } }"}'`
MUTATION	`moveLead`(input: MoveLeadInput!)	Move to another step GraphQL only	MoveLeadPayload
Example Example: moveLeadGraphQLcURL `mutation MoveLead { moveLead(input: {entity: {id: "<lead id>"}}) { result { id name formattedName 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":"mutation MoveLead { moveLead(input: {entity: {id: \"<lead id>\"}}) { result { id name formattedName modified } } }"}'`
MUTATION	`createLead`(input: CreateLeadInput!, validationLevel: [ValidationLevel!])	Create one record	CreateLeadPayload
Example Example: createLeadGraphQLcURL `mutation CreateLead { createLead(input: {name: "Northwind Analytics"}) { lead { id name formattedName 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":"mutation CreateLead { createLead(input: {name: \"Northwind Analytics\"}) { lead { id name formattedName modified } } }"}'`
MUTATION	`updateLead`(input: UpdateLeadInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateLeadPayload
Example Example: updateLeadGraphQLcURL `mutation UpdateLead { updateLead(input: {id: "<lead id>"}) { lead { id name formattedName 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":"mutation UpdateLead { updateLead(input: {id: \"<lead id>\"}) { lead { id name formattedName modified } } }"}'`
MUTATION	`bulkUpdateLead`(input: [CreateOrUpdateLeadInput!]!, deleteInput: [DeleteLeadInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateLeadPayload
Example Example: bulkUpdateLeadGraphQLcURL `mutation BulkUpdateLead { bulkUpdateLead(input: [{id: "<lead id>"}]) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }` `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":"mutation BulkUpdateLead { bulkUpdateLead(input: [{id: \"<lead id>\"}]) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'`
MUTATION	`deleteLead`(input: DeleteLeadInput!)	Soft-delete	DeleteLeadPayload
Example Example: deleteLeadGraphQLcURL `mutation DeleteLead { deleteLead(input: {id: "<lead id>"}) { lead { id name formattedName 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":"mutation DeleteLead { deleteLead(input: {id: \"<lead id>\"}) { lead { id name formattedName modified } } }"}'`
MUTATION	`bulkArchiveLead`(input: BulkArchiveLeadInput!)	Archive many GraphQL only	BulkArchiveLeadPayload
Example Example: bulkArchiveLeadGraphQLcURL `mutation BulkArchiveLead { bulkArchiveLead(input: {bulkFilter: {includedIds: ["<lead id>"]}}) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }` `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":"mutation BulkArchiveLead { bulkArchiveLead(input: {bulkFilter: {includedIds: [\"<lead id>\"]}}) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'`
MUTATION	`bulkReactivateLead`(input: BulkReactivateLeadInput!)	Undo archive for many GraphQL only	BulkReactivateLeadPayload
Example Example: bulkReactivateLeadGraphQLcURL `mutation BulkReactivateLead { bulkReactivateLead(input: {bulkFilter: {includedIds: ["<lead id>"]}}) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }` `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":"mutation BulkReactivateLead { bulkReactivateLead(input: {bulkFilter: {includedIds: [\"<lead id>\"]}}) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'`
MUTATION	`bulkQualifyLead`(input: BulkQualifyLeadInput!)	Qualify many GraphQL only	BulkQualifyLeadPayload
Example Example: bulkQualifyLeadGraphQLcURL `mutation BulkQualifyLead { bulkQualifyLead( input: {bulkFilter: {includedIds: ["<lead id>"]}, entity: {id: "<lead id>"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }` `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":"mutation BulkQualifyLead { bulkQualifyLead( input: {bulkFilter: {includedIds: [\"<lead id>\"]}, entity: {id: \"<lead id>\"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'`
MUTATION	`bulkMoveLead`(input: BulkMoveLeadInput!)	Move many to another step GraphQL only	BulkMoveLeadPayload
Example Example: bulkMoveLeadGraphQLcURL `mutation BulkMoveLead { bulkMoveLead( input: {bulkFilter: {includedIds: ["<lead id>"]}, entity: {id: "<lead id>"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }` `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":"mutation BulkMoveLead { bulkMoveLead( input: {bulkFilter: {includedIds: [\"<lead id>\"]}, entity: {id: \"<lead id>\"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'`
MUTATION	`convertLead`(input: CreateLeadInput!, sourceEntity: EntityNameEnum!, sourceEntityId: UUID!, operation: RecordConversionOperationEnum!, options: RecordConversionOptions!, sourceEntityApiName: String, validationLevel: [ValidationLevel!])	Create from another record GraphQL only	ConvertLeadPayload
Example Example: convertLeadGraphQLcURL `mutation ConvertLead { convertLead( input: {name: "Northwind Analytics"} sourceEntity: AiAgent sourceEntityId: "<source entity id>" operation: Nothing options: {} ) { lead { id name formattedName 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":"mutation ConvertLead { convertLead( input: {name: \"Northwind Analytics\"} sourceEntity: AiAgent sourceEntityId: \"<source entity id>\" operation: Nothing options: {} ) { lead { id name formattedName modified } } }"}'`
MUTATION	`backToLead`(input: BackToLeadInput!)	Turn back into a lead GraphQL only	BackToLeadPayload
Example Example: backToLeadGraphQLcURL `mutation BackToLead { backToLead(input: {entity: {id: "<lead id>"}}) { result { id name formattedName 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":"mutation BackToLead { backToLead(input: {entity: {id: \"<lead id>\"}}) { result { id name formattedName modified } } }"}'`
MUTATION	`bulkBackToLead`(input: BulkBackToLeadInput!)	Turn many back into leads GraphQL only	BulkBackToLeadPayload
Example Example: bulkBackToLeadGraphQLcURL `mutation BulkBackToLead { bulkBackToLead( input: {bulkFilter: {includedIds: ["<lead id>"]}, entity: {id: "<lead id>"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }` `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":"mutation BulkBackToLead { bulkBackToLead( input: {bulkFilter: {includedIds: [\"<lead id>\"]}, entity: {id: \"<lead id>\"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'`

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.

LeadEntity object 65 fields: customFields, pendingScheduledActions, isDeleteProtected, …

Potential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost.

Field	Type	Description
`customFields`	JSONString! (1 args)	Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
`pendingScheduledActions`	Int	Filled only when a single record is read by its id; otherwise null or an empty list.
`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.
`currencyExchangeRatesList`	CurrencyExchangeRatesListEntity	Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default.
`leadSource`	DataEntity	How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space.
`leadType`	LeadTypeEntity	Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply.
`owner`	ClientEntity	Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over.
`reasonOfClose`	DataEntity	Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it.
`step`	StepEntity	Step in the lead process the lead is currently in.
`unit`	SalesUnitEntity	Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to this lead.
`description`	String	Free-form description of the lead.
`isArchived`	Boolean	True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated.
`labelFlag`	Int	User-set colored flag used to highlight the lead in lists and reports.
`lastAiBuyingCenterApplied`	DateTime	Time when an AI-suggested buying center was last applied to this lead.
`leadSourceId`	ID	Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show).
`leadTypeId`	ID	Id of the lead type that classifies the lead and drives which form, fields and lead process apply.
`name`	String!	Name of the entity and its default text representation.
`ownerId`	ID	Id of the lead owner.
`quickAccountEmail`	String	Free-text company email captured at lead creation when no Account record has been linked yet.
`quickAccountName`	String	Free-text company name captured at lead creation when no Account record has been linked yet.
`quickAccountPhone`	String	Free-text company phone captured at lead creation when no Account record has been linked yet.
`quickContactName`	String	Free-text contact name captured at lead creation when no Contact record has been linked yet.
`quickEmail`	String	Free-text contact email captured at lead creation when no Contact record has been linked yet.
`quickPhone`	String	Free-text contact phone captured at lead creation when no Contact record has been linked yet.
`ranking`	Int	Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead.
`reasonOfCloseDescription`	String	Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose.
`reasonOfCloseId`	ID	Id of the reason recorded when the lead is archived (lost), or empty when none was given.
`shareMode`	ShareModeEnum	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
`stepId`	ID	Id of the lead process step.
`tableName`	String!	Discriminator identifying the concrete record type — always "lead" for Lead records. Read-only; useful when consuming polymorphic LeadOppty results.
`unitId`	ID	Id of the sales unit.
`revision`	Int	Revision when entity was lastly changed.
`primaryContact`	ContactEntity	Primary contact of this lead. Set automatically from the contact relation marked as primary.
`primaryAccount`	AccountEntity	Primary account of this lead. Set automatically from the account relation marked as primary.
`contactRelations`	LeadOpptyContactRelationEntityConnection (8 args)	Contacts linked to this lead, including their roles and org-chart positions.
`accountRelations`	LeadOpptyAccountRelationEntityConnection (8 args)	Accounts linked to this lead, including the primary-account flag.
`status`	LeadStatusEnum!	Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events.
`sharingUnits`	LeadOpptySharingSalesUnitRelationEntityConnection (8 args)	Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing.
`sharingClients`	LeadOpptySharingClientRelationEntityConnection (8 args)	Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing.
`documents`	CloudObjectRelationEntityConnection (8 args)	Documents linked to this lead.
`enrolledEmailSequences`	Int!	Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
`tags`	TagRelationEntityConnection (8 args)	Tag labels applied to this lead.
`staticProfiles`	ProfileRelationEntityConnection (8 args)	Saved view profiles this lead currently matches.
`qualifyDate`	DateTime	Timestamp of when the lead was qualified, taken from the matching KPI event. Empty for leads that have not been qualified. Read-only.
`daysInStep`	Int!	Number of days the lead has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event.
`fitness`	WarningLevelEnum	Filled only when a single record is read by its id; otherwise null or an empty list.
`fitnessDescription`	FitnessDescription	Filled only when a single record is read by its id; otherwise null or an empty list.
`isFavorite`	Boolean!	True when the current authenticated user has marked this lead as favorite. Per-user.
`lostDate`	DateTime	Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived.
`formattedName`	String!	Display version of the lead name, used in lists and references.
`scoring`	EntityScoringResult	Lead scoring summary, combining the percentile and current scoring state. Read-only; computed by Coevera.
`viewerIdsPerSalesUnit`	[UUID!]!	Filled only when a single record is read by its id; otherwise null or an empty list.
`modifiedByUser`	DateTime	Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.
`relatedEntitiesDrilldown`	CompactViewDrilldownModel! (1 args)	Records of the given entity type that are related to this record, as a drilldown list.
`charts`	[DashboardChartData!] (1 args)	Data of the given preview pane charts and lists, computed for this record.
`chartsDrilldown`	CompactViewDrilldownModel! (3 args)	Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart.
`fields`	[InterfaceFieldData]! (2 args)	Values of the fields shown in the record's preview pane, as configured for the record's type.
`stepChecklists`	[StepChecklistActivityItem]! (1 args)	Checklist items of the steps of the record's lead process, with the completion state of each item for this record.
`approval`	ApprovalEntity	Approval request of this record that is pending or was rejected; null when there is none or it was approved.

LeadEntityConnection object pageInfo: PageInfo!, edges: [LeadEntityEdge]!, totalCount: Int

Paginated list of Lead records.

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

LeadEntityEdge object node: LeadEntity, cursor: String!

A Relay edge containing a LeadEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[LeadFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[LeadFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	LeadFilterInput	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.
`currencyExchangeRatesListId`	EntityFilterStringField	Id of the currency exchange rate list applied to this lead.
`description`	EntityFilterStringField	Free-form description of the lead.
`isArchived`	Boolean	True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated.
`labelFlag`	LabelFlagEnumFilterInput	User-set colored flag used to highlight the lead in lists and reports.
`lastAiBuyingCenterApplied`	EntityFilterDateTimeField	Time when an AI-suggested buying center was last applied to this lead.
`leadSourceId`	EntityFilterStringField	Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show).
`leadTypeId`	EntityFilterStringField	Id of the lead type that classifies the lead and drives which form, fields and lead process apply.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`ownerId`	EntityFilterStringField	Id of the lead owner.
`quickAccountEmail`	EntityFilterStringField	Free-text company email captured at lead creation when no Account record has been linked yet.
`quickAccountName`	EntityFilterStringField	Free-text company name captured at lead creation when no Account record has been linked yet.
`quickAccountPhone`	EntityFilterStringField	Free-text company phone captured at lead creation when no Account record has been linked yet.
`quickContactName`	EntityFilterStringField	Free-text contact name captured at lead creation when no Contact record has been linked yet.
`quickEmail`	EntityFilterStringField	Free-text contact email captured at lead creation when no Contact record has been linked yet.
`quickPhone`	EntityFilterStringField	Free-text contact phone captured at lead creation when no Contact record has been linked yet.
`ranking`	EntityFilterNumberField	Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead.
`reasonOfCloseDescription`	EntityFilterStringField	Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose.
`reasonOfCloseId`	EntityFilterStringField	Id of the reason recorded when the lead is archived (lost), or empty when none was given.
`shareMode`	ShareModeEnumFilterInput	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
`stepId`	EntityFilterStringField	Id of the lead process step.
`tableName`	EntityFilterStringField	Discriminator identifying the concrete record type — always "lead" for Lead records. Read-only; useful when consuming polymorphic LeadOppty results.
`unitId`	EntityFilterStringField	Id of the sales unit.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`status`	LeadStatusEnumFilterInput	Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events.
`enrolledEmailSequences`	Int	Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
`relatedEntities`	[EntityFilterRelatedField]	Matches records related to at least one of the listed records.
`withCustom`	[CustomField!]	Conditions on custom fields, each identified by its api name. All listed conditions must match.
`currencyExchangeRatesList`	CurrencyExchangeRatesListFilterInput	Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default. Matches records where a related record meets these conditions.
`leadSource`	DataFilterInput	How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space. Matches records where a related record meets these conditions.
`leadType`	LeadTypeFilterInput	Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over. Matches records where a related record meets these conditions.
`reasonOfClose`	DataFilterInput	Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it. Matches records where a related record meets these conditions.
`step`	StepFilterInput	Step in the lead process the lead is currently in. Matches records where a related record meets these conditions.
`unit`	SalesUnitFilterInput	Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions.
`primaryContact`	ContactFilterInput	Primary contact of this lead. Set automatically from the contact relation marked as primary. Matches records where a related record meets these conditions.
`primaryAccount`	AccountFilterInput	Primary account of this lead. Set automatically from the account relation marked as primary. Matches records where a related record meets these conditions.
`contactRelations`	LeadOpptyContactRelationFilterInput	Contacts linked to this lead, including their roles and org-chart positions. Matches records where a related record meets these conditions.
`accountRelations`	LeadOpptyAccountRelationFilterInput	Accounts linked to this lead, including the primary-account flag. Matches records where a related record meets these conditions.
`sharingUnits`	LeadOpptySharingSalesUnitRelationFilterInput	Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions.
`sharingClients`	LeadOpptySharingClientRelationFilterInput	Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions.
`documents`	CloudObjectRelationFilterInput	Documents linked to this lead. Matches records where a related record meets these conditions.
`tags`	TagRelationFilterInput	Tag labels applied to this lead. Matches records where a related record meets these conditions.
`staticProfiles`	ProfileRelationFilterInput	Saved view profiles this lead currently matches. Matches records where a related record meets these conditions.

LeadOrderByInput input Asc or Desc per field

Sorting of Lead 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.
`currencyExchangeRatesList`	[CurrencyExchangeRatesListOrderByNestedInput!]	Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority.
`leadSource`	[DataOrderByNestedInput!]	How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space. Sorts by fields of the related record, listed in order of priority.
`leadType`	[LeadTypeOrderByNestedInput!]	Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over. Sorts by fields of the related record, listed in order of priority.
`reasonOfClose`	[DataOrderByNestedInput!]	Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it. Sorts by fields of the related record, listed in order of priority.
`step`	[StepOrderByNestedInput!]	Step in the lead process the lead is currently in. Sorts by fields of the related record, listed in order of priority.
`unit`	[SalesUnitOrderByNestedInput!]	Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority.
`currencyExchangeRatesListId`	OrderByEnum	Id of the currency exchange rate list applied to this lead.
`description`	OrderByEnum	Free-form description of the lead.
`isArchived`	OrderByEnum	True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated.
`labelFlag`	OrderByEnum	User-set colored flag used to highlight the lead in lists and reports.
`leadSourceId`	OrderByEnum	Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show).
`leadTypeId`	OrderByEnum	Id of the lead type that classifies the lead and drives which form, fields and lead process apply.
`name`	OrderByEnum	Name of the entity and its default text representation.
`ownerId`	OrderByEnum	Id of the lead owner.
`quickAccountEmail`	OrderByEnum	Free-text company email captured at lead creation when no Account record has been linked yet.
`quickAccountName`	OrderByEnum	Free-text company name captured at lead creation when no Account record has been linked yet.
`quickAccountPhone`	OrderByEnum	Free-text company phone captured at lead creation when no Account record has been linked yet.
`quickContactName`	OrderByEnum	Free-text contact name captured at lead creation when no Contact record has been linked yet.
`quickEmail`	OrderByEnum	Free-text contact email captured at lead creation when no Contact record has been linked yet.
`quickPhone`	OrderByEnum	Free-text contact phone captured at lead creation when no Contact record has been linked yet.
`ranking`	OrderByEnum	Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead.
`reasonOfCloseDescription`	OrderByEnum	Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose.
`reasonOfCloseId`	OrderByEnum	Id of the reason recorded when the lead is archived (lost), or empty when none was given.
`shareMode`	OrderByEnum	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
`stepId`	OrderByEnum	Id of the lead process step.
`unitId`	OrderByEnum	Id of the sales unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.
`status`	OrderByEnum	Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events.
`enrolledEmailSequences`	OrderByEnum	Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
`relatedEntities`	CommonEntityRepositoryOrderByEntityRelationField	Sorts records by whether they are related to the listed records.
`withCustom`	CommonEntityRepositoryOrderByCustomField	Sorts by a custom field.

LeadStatusEnumFilterInput input eq: [LeadStatusEnum!], NOT: LeadStatusEnumFilterInput

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

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

ArchiveLeadInput input completeActivityIds: [UUID!], memoText: String, id: ID!, clientMutationId: String

Parameters of the archiveLead mutation.

Input field	Type	Description
`completeActivityIds`	[UUID!]	Ids of tasks linked to the lead to mark as completed.
`memoText`	String	Text of a memo added to the lead together with the archive.
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

BackToLeadInput input entity: UpdateLeadInput!, clientMutationId: String

Parameters of the backToLead mutation.

Input field	Type	Description
`entity`	UpdateLeadInput!	Id of the opportunity, the target lead step (stepId) and any lead field values to save with the conversion.
`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).

BulkArchiveLeadInput input 6 fields: bulkFilter, rollbackMethod, entity, …

Parameters of the bulkArchiveLead mutation.

Input field	Type	Description
`bulkFilter`	BulkOperationInput!	Leads to archive: includedIds minus excludedIds. Integrations can leave sessionId empty.
`rollbackMethod`	RollbackMethod	ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
`entity`	CreateOrUpdateLeadInput	Optional field values saved on every archived lead.
`memoText`	String	Text of a memo added to every archived lead.
`completeActivityIds`	[UUID!]	Ids of linked tasks to mark as completed.
`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).

BulkBackToLeadInput input bulkFilter: BulkOperationInput!, entity: CreateOrUpdateLeadInput!, rollbackMethod: RollbackMethod, clientMutationId: String

Parameters of the bulkBackToLead mutation.

Input field	Type	Description
`bulkFilter`	BulkOperationInput!	Opportunities to convert: includedIds minus excludedIds. Integrations can leave sessionId empty.
`entity`	CreateOrUpdateLeadInput!	Lead field values applied to every converted record, such as the target lead stepId.
`rollbackMethod`	RollbackMethod	ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
`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).

BulkMoveLeadInput input 6 fields: bulkFilter, entity, memoText, …

Parameters of the bulkMoveLead mutation.

Input field	Type	Description
`bulkFilter`	BulkOperationInput!	Leads to move: includedIds minus excludedIds. Integrations can leave sessionId empty.
`entity`	CreateOrUpdateLeadInput!	Target step (stepId) and field values applied to every lead.
`memoText`	String	Text of a memo added to every moved lead.
`completeActivityIds`	[UUID!]	Ids of linked tasks to mark as completed.
`rollbackMethod`	RollbackMethod	ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
`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).

BulkQualifyLeadInput input bulkFilter: BulkOperationInput!, entity: CreateOrUpdateOpportunityInput!, rollbackMethod: RollbackMethod, clientMutationId: String

Parameters of the bulkQualifyLead mutation.

Input field	Type	Description
`bulkFilter`	BulkOperationInput!	Leads to qualify: includedIds minus excludedIds. Integrations can leave sessionId empty.
`entity`	CreateOrUpdateOpportunityInput!	Target opportunity step (stepId) and opportunity field values applied to every lead.
`rollbackMethod`	RollbackMethod	ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
`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).

BulkReactivateLeadInput input bulkFilter: BulkOperationInput!, rollbackMethod: RollbackMethod, clientMutationId: String

Parameters of the bulkReactivateLead mutation.

Input field	Type	Description
`bulkFilter`	BulkOperationInput!	Records to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty.
`rollbackMethod`	RollbackMethod	ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
`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).

ChangeLabelFlagLeadInput input 5 fields: hot, priority, stalled, …

Parameters of the changeLabelFlagLead mutation.

Input field	Type	Description
`hot`	Boolean!	Marks the record as hot.
`priority`	Boolean!	Marks the record as priority.
`stalled`	Boolean!	Marks the record as stalled.
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

ChangeOwnershipLeadInput input 6 fields: ownerId, unitId, keepOwnerAsEditor, …

Parameters of the changeOwnershipLead mutation.

Input field	Type	Description
`ownerId`	ID!	User who becomes the new owner of the record.
`unitId`	ID!	Sales unit the record is assigned to.
`keepOwnerAsEditor`	Boolean!	When true, the previous owner (if still an active user) stays on the record as a shared user with the Editor role, and a Private sharing mode is switched to Standard.
`transferLinkedRecords`	Boolean!	When true, the new owner and sales unit are also applied to the record's open tasks and appointments and its notes. Linked records that cannot be transferred are skipped without failing the mutation.
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

CopyLeadInput input skipCopySuffix: Boolean, id: ID!, clientMutationId: String

Parameters of the copyLead mutation.

Input field	Type	Description
`skipCopySuffix`	Boolean	When true, the copy keeps the original name without the copy suffix. Defaults to false.
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

CreateLeadInput input 34 fields: clientMutationId, modified, created, …

Field values of a new Lead 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.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to this lead.
`description`	String	Free-form description of the lead.
`isArchived`	Boolean	True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated.
`labelFlag`	Int	User-set colored flag used to highlight the lead in lists and reports.
`lastAiBuyingCenterApplied`	DateTime	Time when an AI-suggested buying center was last applied to this lead.
`leadSourceId`	ID	Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show).
`leadTypeId`	ID	Id of the lead type that classifies the lead and drives which form, fields and lead process apply.
`name`	String!	Name of the entity and its default text representation.
`ownerId`	ID	Id of the lead owner.
`quickAccountEmail`	String	Free-text company email captured at lead creation when no Account record has been linked yet.
`quickAccountName`	String	Free-text company name captured at lead creation when no Account record has been linked yet.
`quickAccountPhone`	String	Free-text company phone captured at lead creation when no Account record has been linked yet.
`quickContactName`	String	Free-text contact name captured at lead creation when no Contact record has been linked yet.
`quickEmail`	String	Free-text contact email captured at lead creation when no Contact record has been linked yet.
`quickPhone`	String	Free-text contact phone captured at lead creation when no Contact record has been linked yet.
`ranking`	Int	Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead.
`reasonOfCloseDescription`	String	Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose.
`reasonOfCloseId`	ID	Id of the reason recorded when the lead is archived (lost), or empty when none was given.
`shareMode`	ShareModeEnum	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
`stepId`	ID	Id of the lead process step.
`unitId`	ID	Id of the sales unit.
`customFields`	JSONString	Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
`revision`	Int	Revision when entity was lastly changed.
`contactRelations`	[CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!]	Contacts linked to this lead, including their roles and org-chart positions.
`accountRelations`	[CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!]	Accounts linked to this lead, including the primary-account flag.
`sharingUnits`	[CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!]	Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing.
`sharingClients`	[CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!]	Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing.
`documents`	[CreateCloudObjectRelationNoBackrefInput!]	Documents linked to this lead.
`tags`	[CreateTagRelationNoLeadBackrefInput!]	Tag labels applied to this lead.
`staticProfiles`	[CreateProfileRelationNoLeadOpptyBackrefInput!]	Saved view profiles this lead currently matches.
`lostDate`	DateTime	Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived.

CreateOrUpdateLeadInput input 35 fields: clientMutationId, id, modified, …

Field values of a Lead 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.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to this lead.
`description`	String	Free-form description of the lead.
`isArchived`	Boolean	True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated.
`labelFlag`	Int	User-set colored flag used to highlight the lead in lists and reports.
`lastAiBuyingCenterApplied`	DateTime	Time when an AI-suggested buying center was last applied to this lead.
`leadSourceId`	ID	Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show).
`leadTypeId`	ID	Id of the lead type that classifies the lead and drives which form, fields and lead process apply.
`name`	String	Name of the entity and its default text representation.
`ownerId`	ID	Id of the lead owner.
`quickAccountEmail`	String	Free-text company email captured at lead creation when no Account record has been linked yet.
`quickAccountName`	String	Free-text company name captured at lead creation when no Account record has been linked yet.
`quickAccountPhone`	String	Free-text company phone captured at lead creation when no Account record has been linked yet.
`quickContactName`	String	Free-text contact name captured at lead creation when no Contact record has been linked yet.
`quickEmail`	String	Free-text contact email captured at lead creation when no Contact record has been linked yet.
`quickPhone`	String	Free-text contact phone captured at lead creation when no Contact record has been linked yet.
`ranking`	Int	Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead.
`reasonOfCloseDescription`	String	Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose.
`reasonOfCloseId`	ID	Id of the reason recorded when the lead is archived (lost), or empty when none was given.
`shareMode`	ShareModeEnum	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
`stepId`	ID	Id of the lead process step.
`unitId`	ID	Id of the sales unit.
`customFields`	JSONString	Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
`revision`	Int	Revision when entity was lastly changed.
`contactRelations`	[CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!]	Contacts linked to this lead, including their roles and org-chart positions.
`accountRelations`	[CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!]	Accounts linked to this lead, including the primary-account flag.
`sharingUnits`	[CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!]	Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing.
`sharingClients`	[CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!]	Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing.
`documents`	[CreateCloudObjectRelationNoBackrefInput!]	Documents linked to this lead.
`tags`	[CreateTagRelationNoLeadBackrefInput!]	Tag labels applied to this lead.
`staticProfiles`	[CreateProfileRelationNoLeadOpptyBackrefInput!]	Saved view profiles this lead currently matches.
`lostDate`	DateTime	Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived.

CreateTagRelationNoLeadBackrefInput input 15 fields: modified, created, accountId, …

Field values of a new TagRelation record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`accountId`	ID	Id of the linked account.
`appointmentId`	ID	Id of the linked appointment.
`contactId`	ID	Id of the linked contact.
`customEntityId`	ID	Id of the linked custom entity record.
`emailId`	ID	Id of the linked email.
`opptyId`	ID	Id of the linked opportunity.
`processId`	ID	Id of the linked sales process.
`projectId`	ID	Id of the linked project.
`quoteId`	ID	Id of the linked quote.
`solutionId`	ID	Id of the linked solution.
`tagId`	ID!	Id of the tag attached to the record.
`taskId`	ID	Id of the linked task.
`revision`	Int	Revision when entity was lastly changed.

DeleteLeadInput input clientMutationId: String, id: ID!

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

ManageSharingLeadInput input 5 fields: shareMode, sharingClients, sharingUnits, …

Parameters of the manageSharingLead mutation.

Input field	Type	Description
`shareMode`	ShareModeEnum!	Sharing mode of the record: Standard, Private, AllView or AllEdit.
`sharingClients`	[CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!]	Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users.
`sharingUnits`	[CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!]	Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units.
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

MoveLeadInput input entity: UpdateLeadInput!, memoText: String, completeActivityIds: [UUID!], clientMutationId: String

Parameters of the moveLead mutation.

Input field	Type	Description
`entity`	UpdateLeadInput!	Id of the lead, the target step (stepId) and any field values to save with the move.
`memoText`	String	Text of a memo added to the lead together with the move.
`completeActivityIds`	[UUID!]	Ids of tasks linked to the lead to mark as completed.
`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).

QualifyLeadInput input entity: UpdateOpportunityInput!, clientMutationId: String

Parameters of the qualifyLead mutation.

Input field	Type	Description
`entity`	UpdateOpportunityInput!	Id of the lead, the target opportunity step (stepId) and any opportunity field values to 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).

ReactivateLeadInput input id: ID!, clientMutationId: String

Parameters of the reactivateLead mutation.

Input field	Type	Description
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

ReleaseOwnershipLeadInput input id: ID!, clientMutationId: String

Parameters of the releaseOwnershipLead mutation.

Input field	Type	Description
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

RestoreLeadInput input id: ID!, clientMutationId: String

Parameters of the restoreLead mutation.

Input field	Type	Description
`id`	ID!	Identifier of the LeadEntity to perform the action on.
`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).

UpdateLeadInput input 35 fields: clientMutationId, id, modified, …

Id of a Lead 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.
`currencyExchangeRatesListId`	ID	Id of the currency exchange rate list applied to this lead.
`description`	String	Free-form description of the lead.
`isArchived`	Boolean	True when the lead has been archived (lost). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated.
`labelFlag`	Int	User-set colored flag used to highlight the lead in lists and reports.
`lastAiBuyingCenterApplied`	DateTime	Time when an AI-suggested buying center was last applied to this lead.
`leadSourceId`	ID	Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show).
`leadTypeId`	ID	Id of the lead type that classifies the lead and drives which form, fields and lead process apply.
`name`	String	Name of the entity and its default text representation.
`ownerId`	ID	Id of the lead owner.
`quickAccountEmail`	String	Free-text company email captured at lead creation when no Account record has been linked yet.
`quickAccountName`	String	Free-text company name captured at lead creation when no Account record has been linked yet.
`quickAccountPhone`	String	Free-text company phone captured at lead creation when no Account record has been linked yet.
`quickContactName`	String	Free-text contact name captured at lead creation when no Contact record has been linked yet.
`quickEmail`	String	Free-text contact email captured at lead creation when no Contact record has been linked yet.
`quickPhone`	String	Free-text contact phone captured at lead creation when no Contact record has been linked yet.
`ranking`	Int	Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead.
`reasonOfCloseDescription`	String	Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose.
`reasonOfCloseId`	ID	Id of the reason recorded when the lead is archived (lost), or empty when none was given.
`shareMode`	ShareModeEnum	Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
`stepId`	ID	Id of the lead process step.
`unitId`	ID	Id of the sales unit.
`customFields`	JSONString	Custom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
`revision`	Int	Revision when entity was lastly changed.
`contactRelations`	[CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!]	Contacts linked to this lead, including their roles and org-chart positions.
`accountRelations`	[CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!]	Accounts linked to this lead, including the primary-account flag.
`sharingUnits`	[CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!]	Sales units that have been granted shared access to this lead. Editable only when shareMode allows unit sharing.
`sharingClients`	[CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!]	Users that have been granted shared access to this lead. Editable only when shareMode allows user sharing.
`documents`	[CreateCloudObjectRelationNoBackrefInput!]	Documents linked to this lead.
`tags`	[CreateTagRelationNoLeadBackrefInput!]	Tag labels applied to this lead.
`staticProfiles`	[CreateProfileRelationNoLeadOpptyBackrefInput!]	Saved view profiles this lead currently matches.
`lostDate`	DateTime	Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived.

ArchiveLeadPayload object result: LeadEntity, clientMutationId: String

Result of the archiveLead mutation.

Field	Type	Description
`result`	LeadEntity	The archived lead.
`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).

BackToLeadPayload object result: LeadEntity, clientMutationId: String

Result of the backToLead mutation.

Field	Type	Description
`result`	LeadEntity	The resulting lead.
`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).

BulkArchiveLeadPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkArchiveLead mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the archived leads and the items that failed.
`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).

BulkBackToLeadPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkBackToLead mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the converted records and the items that failed.
`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).

BulkMoveLeadPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkMoveLead mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the moved leads and the items that failed.
`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).

BulkQualifyLeadPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkQualifyLead mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the qualified records (the new opportunities keep the lead ids) and the items that failed.
`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).

BulkReactivateLeadPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkReactivateLead mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the reactivated records and the items that failed.
`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).

BulkUpdateLeadPayload object result: BulkUpdateResults!

Result of the bulkUpdateLead mutation.

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

ChangeLabelFlagLeadPayload object result: LeadEntity, clientMutationId: String

Result of the changeLabelFlagLead mutation.

Field	Type	Description
`result`	LeadEntity	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).

ChangeOwnershipLeadPayload object result: LeadEntity, clientMutationId: String

Result of the changeOwnershipLead mutation.

Field	Type	Description
`result`	LeadEntity	The record with its new owner.
`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).

ConvertLeadPayload object lead: LeadEntity!, clientMutationId: String

Result of the convertLead mutation.

Field	Type	Description
`lead`	LeadEntity!	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).

CopyLeadPayload object result: LeadEntity, clientMutationId: String

Result of the copyLead mutation.

Field	Type	Description
`result`	LeadEntity	The new lead.
`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).

CreateLeadPayload object lead: LeadEntity, clientMutationId: String

Result of the createLead mutation.

Field	Type	Description
`lead`	LeadEntity	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).

DeleteLeadPayload object lead: LeadEntity, clientMutationId: String

Result of the deleteLead mutation.

Field	Type	Description
`lead`	LeadEntity	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).

ManageSharingLeadPayload object result: LeadEntity, clientMutationId: String

Result of the manageSharingLead mutation.

Field	Type	Description
`result`	LeadEntity	The record with its updated sharing.
`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).

MoveLeadPayload object result: LeadEntity, clientMutationId: String

Result of the moveLead mutation.

Field	Type	Description
`result`	LeadEntity	The moved lead.
`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).

QualifyLeadPayload object result: OpportunityEntity, clientMutationId: String

Result of the qualifyLead mutation.

Field	Type	Description
`result`	OpportunityEntity	The created opportunity.
`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).

ReactivateLeadPayload object result: LeadEntity, clientMutationId: String

Result of the reactivateLead mutation.

Field	Type	Description
`result`	LeadEntity	The reactivated lead.
`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).

ReleaseOwnershipLeadPayload object result: LeadEntity, clientMutationId: String

Result of the releaseOwnershipLead mutation.

Field	Type	Description
`result`	LeadEntity	The released lead.
`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).

RestoreLeadPayload object result: LeadEntity, clientMutationId: String

Result of the restoreLead mutation.

Field	Type	Description
`result`	LeadEntity	The restored 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).

UpdateLeadPayload object lead: LeadEntity, clientMutationId: String

Result of the updateLead mutation.

Field	Type	Description
`lead`	LeadEntity	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).

EntityScoringResult object 8 fields: categories, score, trend, …

Score of a record: its value, trend and category, and the rules that affect it.

Field	Type	Description
`categories`	[EntityScoringCategory!]!	Score categories of the scoring, such as Hot, Warm and Cold.
`score`	Int!	Score of the record as a percentile from 0 to 100, comparing its rule points with those of the other records of the same scoring; 0 when it has no points.
`trend`	EntityScoringTrendEnum!	How the score changed compared with the previous calculation.
`rules`	[EntityScoringResultRule!]!	Scoring rules that currently add points to the score of the record, or subtract them.
`entityScoringId`	UUID!	Id of the scoring the record was scored by.
`entityScoringName`	String!	Name of the scoring the record was scored by.
`entityScoringUseLang`	Boolean!	When true, entityScoringName is treated as a translation key and resolved through the translation system; otherwise the literal text is shown.
`lastCalculation`	DateTime!	When the score of the record was last calculated.

EntityScoringResultRule object id: UUID!, name: String!, useLang: Boolean!, trend: EntityScoringTrendEnum!

Scoring rule that currently adds points to the score of a record, or subtracts them.

Field	Type	Description
`id`	UUID!	Id of the scoring rule.
`name`	String!	Name of the scoring rule.
`useLang`	Boolean!	When true, name is treated as a translation key and resolved through the translation system; otherwise the literal text is shown.
`trend`	EntityScoringTrendEnum!	Whether the rule adds points to the score or subtracts them.

EntityScoringTrendEnum enum Decreasing, Increasing, NoChange

Direction of a record's score, or of one scoring rule's contribution to it.

Value	Description
`Decreasing`	The score went down, or the rule subtracts points.
`Increasing`	The score went up, or the rule adds points.
`NoChange`	The score did not change, or the rule adds no points.

LeadAutoPrefill object entity: LeadEntity, fieldIds: [UUID!]!

New, unsaved lead pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in.

Field	Type	Description
`entity`	LeadEntity	New lead carrying the pre-filled values; it is not saved.
`fieldIds`	[UUID!]!	Ids of the fields that were filled in.

LeadStatusEnum enum Open, Lost, Qualified

Status of a lead.

Value	Description
`Open`	The lead is active.
`Lost`	The lead was archived as lost.
`Qualified`	The lead was qualified into an opportunity.