zohoStartMigration

Requires permission settings:integration:update.

Starts the one-time migration of data from Zoho, optionally limited to some warehouses, and returns its checkpoint as a JSON string. It starts a whole-catalog migration in one call. Requires permission to update integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation ZohoStartMigration {
  zohoStartMigration
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ZohoStartMigration {\n  zohoStartMigration\n}"
}
EOF

Response:

{
  "data": {
    "zohoStartMigration": "string"
  }
}

zohoStartMigration(
  warehouseIds: [String!]
): String!

Arguments

zohoStartMigration.warehouseIds ● [String!] list scalar

Limit the migration to these warehouses. Omit it to migrate all.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.