Settings

Update the organisation name or correspondence details

PATCH/settings
settings:writeupdate_organisation_settingsIdempotent

Changes the name, correspondence email or correspondence name of the platform's main organisation and returns all settings. Send only the fields you change; correspondence_name: null clears it. Feature flags, currency and parent are read-only. dry_run shows the result without saving. Emits organisation_settings.updated to the token organisation's subscribers when something changed, although the change applies to the platform organisation for every organisation on the platform; sends no email. Sending the old values undoes it.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · OrganisationSettingsUpdate

  • namestring#

    The organisation name shown across the platform.

  • correspondence_emailstring (email)#

    The address platform emails are sent from.

  • correspondence_namestring | null#

    The sender name platform emails show; null clears it.

{
  "correspondence_name": "Acme Capital Investor Relations"
}

Responses

200

The organisation settings after the change.

OrganisationSettings
{
  "data": {
    "name": "string",
    "correspondence_email": "string",
    "correspondence_name": "string",
    "currency": "string",
    "parent_organisation_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "feature_flags": [
      {
        "key": "string",
        "category": "deals",
        "title": "string",
        "enabled": true
      }
    ],
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/settings\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "correspondence_name": "Acme Capital Investor Relations"
}'