INPUT_OBJECT

BulkArchiveContactInput

Parameters of the bulkArchiveContact mutation.

link GraphQL Schema definition

  • input BulkArchiveContactInput {
  • # Contacts to archive: includedIds minus excludedIds. Integrations can leave
  • # sessionId empty.
  • bulkFilter: BulkOperationInput!
  • # Field values saved on every archived contact.
  • entity: CreateOrUpdateContactInput!
  • # Archives open leads whose primary contact is one of the contacts.
  • archiveAllRelatedLeads: Boolean
  • # Archives open opportunities whose primary contact is one of the contacts.
  • archiveAllRelatedOpportunities: Boolean
  • # Archives open quotes whose primary contact is one of the contacts.
  • archiveAllRelatedQuotes: Boolean
  • # Marks all tasks linked to each contact as completed.
  • completeAllRelatedTasks: Boolean
  • # Marks tasks of the contacts' leads as completed.
  • completeAllRelatedLeadsTasks: Boolean
  • # Marks tasks of the contacts' opportunities as completed.
  • completeAllRelatedOpportunitiesTasks: Boolean
  • # Marks tasks of the contacts' quotes as completed.
  • completeAllRelatedQuotesTasks: Boolean
  • # 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 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