updateAPISettings

Requires at least one of the permissions settings:api:update or settings:tenant:update.

Updates the API settings: whether the API is on, its version, rate limits per minute and hour, API keys, allowed origins, and webhooks with their retry attempts. Returns the saved settings. Needs settings:api:update, or settings:tenant:update.

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 UpdateAPISettings($input: APISettingsInput!) {
  updateAPISettings(input: $input) {
    id
    createdAt
    category
    dataType
    description
    enteredBy
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateAPISettings($input: APISettingsInput!) {\n  updateAPISettings(input: $input) {\n    id\n    createdAt\n    category\n    dataType\n    description\n    enteredBy\n  }\n}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updateAPISettings": [
      {
        "id": "id",
        "createdAt": "2025-01-15T00:00:00Z",
        "category": "ACCOUNTING",
        "dataType": "ARRAY",
        "description": "string",
        "enteredBy": "string"
      }
    ]
  }
}

updateAPISettings(
  input: APISettingsInput!
): [TenantSetting!]!

Arguments

updateAPISettings.input ● APISettingsInput! non-null input

The API settings to change; fields left out stay as they are.

Type

TenantSetting object

A setting of the organization.