bulkOperationRunMutation

mutation

Creates and runs a bulk operation mutation.

To learn how to bulk import large volumes of data asynchronously, refer to the bulk import data guide.

Arguments

Anchor to clientIdentifierclientIdentifier • String: An optional identifier which may be used for querying.
Anchor to groupObjectsgroupObjects • Boolean!requiredDefault:true: Whether to group objects under their corresponding parent objects in the JSONL output. Grouping is costly, causes bulk operations to take longer to complete, and increases the chances of failures such as timeouts.
Anchor to mutationmutation • String!required: The mutation to be executed in bulk.
Anchor to stagedUploadPathstagedUploadPath • String!required: The staged upload path of the file containing mutation variables.

Was this section helpful?

Anchor to BulkOperationRunMutationPayload returnsBulkOperationRunMutationPayload returns

Anchor to bulkOperationbulkOperation • BulkOperation: The newly created bulk operation.
Anchor to userErrorsuserErrors • [BulkMutationUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation bulkOperationRunMutation($clientIdentifier: String, $groupObjects: Boolean!, $mutation: String!, $stagedUploadPath: String!) {

bulkOperationRunMutation(clientIdentifier: $clientIdentifier, groupObjects: $groupObjects, mutation: $mutation, stagedUploadPath: $stagedUploadPath) {

bulkOperation {

# BulkOperation fields

}

userErrors {

field

message

}

Input

{

"clientIdentifier": "<your-clientIdentifier>",

"groupObjects": true,

"mutation": "<your-mutation>",

"stagedUploadPath": "<your-stagedUploadPath>"

}

{
  "clientIdentifier": "<your-clientIdentifier>",
  "groupObjects": true,
  "mutation": "<your-mutation>",
  "stagedUploadPath": "<your-stagedUploadPath>"
}