Skip to main content

Get Product Preferences

GET 
/v1/products/:productId/preferences

This endpoint returns the preferences of a Product identified by the productId.

Request​

Path Parameters

    productId uuidrequired

    The identifier of the Product.

Responses​

When everything is ok, the product preferences data is returned.

Schema

    reasonRequired boolean

    Indicates that a mandatory note required for saving and publishing.

    keyGenerationMode KeyGenerationMode (string)

    Possible values: [camelCase, lowerCase, upperCase, pascalCase, kebabCase]

    Determines the Feature Flag key generation mode.

    showVariationId boolean

    Indicates whether a variation ID's must be shown on the ConfigCat Dashboard.

    reasonRequiredEnvironments

    object[]

    nullable

    List of Environments where mandatory note must be set before saving and publishing.

  • Array [

    • environmentId uuid

    Identifier of the Environment.

    reasonRequired boolean

    Indicates that a mandatory note is required in this Environment for saving and publishing.

    environmentName stringnullable

    Name of the Environment.

  • ]

    • mandatorySettingHint boolean

    Indicates whether Feature flags and Settings must have a hint.

Loading...