zohoForcePoll

Requires permission settings:integration:update.

Queues an immediate Zoho sync poll for one entity type, instead of waiting for the next scheduled one. Returns a JSON string confirming it was queued. 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 ZohoForcePoll($entityType: String!) {
  zohoForcePoll(entityType: $entityType)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ZohoForcePoll($entityType: String!) {\n  zohoForcePoll(entityType: $entityType)\n}",
  "variables": {
    "entityType": "string"
  }
}
EOF

Variables:

{
  "entityType": "string"
}

Response:

{
  "data": {
    "zohoForcePoll": "string"
  }
}

zohoForcePoll(
  entityType: String!
): String!

Arguments

zohoForcePoll.entityType ● String! non-null scalar

The kind of record to poll for, such as products, customers, sales orders, invoices or payments.

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.