Basic

Set an app's feature flag

Changed on

Set a feature flag for an app. For example, update the hs-hide-crm-cards flag's defaultState to ON to hide classic CRM cards from new installs.

put/feature-flags/2026-09/{appId}/flags/{flagName}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/feature-flags/2026-09/{appId}/flags/{flagName}
  • Auth
    API key in query parameter hapikey

Path parameters

appIdinteger required

The unique identifier of the application associated with the feature flag.

flagNamestring required

The name of the feature flag to update.

Request body

defaultState'ABSENT' | 'OFF' | 'ON' required

The state that the flag should have if there are no overrides for a particular portal

overrideState'ABSENT' | 'OFF' | 'ON'

A flag value that supercedes all other overrides, including portal-level values. Mostly used for things like emergency overrides

Response

successful operation

appIdinteger required

The ID of the app

defaultState'ABSENT' | 'OFF' | 'ON' required

The flag state for any portal that doesn't have an override value

flagNamestring required

The name of the flag

overrideState'ABSENT' | 'OFF' | 'ON'

An optional flag value that overrides all others for this flag name and app, including portal-level values

Changes

  • 2026-09de25edbdcd67Revision changes
    • info

      the endpoint scheme security developer_hapikey was added to the API

    • info

      the endpoint scheme security oauth2 was removed from the API