Sign in
Commerce

Update a feature

Updates an existing catalog feature. Use this operation to change fields such as name, description, values, and tags. Omit tags to preserve existing tags. Send clear_tags: true to remove all tags.

put/commerce/features

Request

  • Base URL: https://rest.test.zuora.com
  • URL: https://rest.test.zuora.com/commerce/features
  • Auth: HTTP bearer

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

idstring required

Unique identifier of the feature to update.

namestring

Unique name of the feature.

descriptionstring

Description of the feature.

type'bool' | 'enumType' | 'numbered' | 'unmetered'

Feature type. Changing the type of an existing feature, for example from enumType to bool, is not allowed.

valuesstring[]

Permitted values for an enumType feature. Replaces the current allowed values.

tagsstring[]

Replacement tag list. Omit this field to preserve existing tags. An empty array does not clear tags unless clear_tags is true.

clear_tagsboolean

When true, removes all tags from the feature.

Example request

{
  "id": "8ad088009840d1c2019855e15c993f2f",
  "name": "sso_access",
  "description": "Grants single sign-on access for enterprise accounts",
  "type": "enumType",
  "values": [
    "basic",
    "pro",
    "enterprise",
    "elite"
  ],
  "tags": [
    "premium"
  ]
}

Response

OK

Example response

{
  "value": {
    "id": "8ad088009840d1c2019855e15c993f2f",
    "featureNumber": "FEAT-00000001",
    "name": "sso_access",
    "description": "Grants single sign-on access",
    "type": "bool",
    "status": "Active",
    "values": [
      "basic",
      "premium",
      "enterprise"
    ],
    "tags": [
      "premium"
    ],
    "unitOfMeasure": "API Calls",
    "isMetered": true,
    "isCapped": true,
    "metricId": "7ec58fadb6f84bc18e59c7529058d941"
  }
}

Changes

No operation changes recorded.