INPUT_OBJECT

BulkArchiveLeadInput

Parameters of the bulkArchiveLead mutation.

link GraphQL Schema definition

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

link Require by