v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Dynamic Configs

Create Dynamic Config

post/console/v1/dynamic_configs

Request body

namestring required

The dynamic config display name

isEnabledboolean

Is the dynamic config enabled

descriptionstring

defaultValueobject

The fallback JSON object when no rules are triggered

defaultValueJson5string

Can include comments. If provided with defaultValue, must parse to the same JSON

idTypestring

The type of ID which the dynamic config is based on.

tagsstring[]

The list of tag names attached to the dynamic config

creatorIDstring nullable

creatorEmailstring nullable

schemastring nullable

A schema using JSON Schema Draft 2020-12 to enforce return values of this dynamic config's rules.

schemaJson5string nullable

schema except with Json5 comments. Optional and should parse to same json as schema.

teamstring nullable

The team name associated with the dynamic config, Enterprise only.

teamIDstring nullable

The team ID associated with the dynamic config, Enterprise only.

releasePipelineIDstring nullable

The release pipeline ID associated with the dynamic config

idstring

The dynamic config name ID

isTemplateboolean

Example request

{
  "name": "my_config",
  "idType": "userID",
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "owner123@test.com"
  }
}

Response

Create Dynamic Config

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Dynamic Config created successfully.",
  "data": {
    "id": "a_dynamic_config",
    "permalink": "https://console.statsig.com/company_id/dynamic_configs/a_dynamic_config",
    "name": "a dynamic config",
    "description": "helpful summary of what this dynamic config does",
    "idType": "userID",
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifiedTime": 1707344887865,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "1vaQaBoLlkauH9iiuOSBP2",
    "createdTime": 1707344887764,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "holdoutIDs": [],
    "tags": [],
    "type": "TEMPORARY",
    "typeReason": "NONE",
    "isPermanent": false,
    "isEnabled": true,
    "rules": [],
    "defaultValue": {}
  }
}