zohoSetApiLimit

Requires permission settings:integration:update.

Sets how many Zoho API calls the organization may make per day. Zero or no value clears the cap and goes back to the plan tier's limit. Returns a JSON string with the limit now in force. 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 ZohoSetApiLimit {
  zohoSetApiLimit
}

cURL

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

Response:

{
  "data": {
    "zohoSetApiLimit": "string"
  }
}

zohoSetApiLimit(
  limit: Int
): String!

Arguments

zohoSetApiLimit.limit ● Int scalar

The daily call cap. Omit it, or send 0, to clear the cap.

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.