Forms

Update an option preset

PATCH/option-presets/{id}
forms:writeupdate_option_presetIdempotent

Changes the fields you send and returns the preset. items, when sent, needs at least one entry. Sending description as null clears it. Fields that link to the preset show the new items at once. dry_run shows the result without saving it. Emits option_preset.updated, only when something really changes, and sends no email. Sending the previous values undoes it.

Path parameters

  • idstring (uuid)Required#

    The option preset's id, a uuid. An unknown id returns 404.

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 · OptionPresetUpdate

  • namestring#

    The preset's display name.

  • descriptionstring | null#

    What the preset is for.

  • itemsstring[]#

    The options, in order.

{
  "items": [
    "Retail",
    "Professional",
    "Family Office"
  ]
}

Responses

200

The updated preset.

OptionPreset
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "description": "string",
    "items": [
      "string"
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "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
404

Resource not found (error.code = not_found).

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/option-presets/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "items": [
    "Retail",
    "Professional",
    "Family Office"
  ]
}'