Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Layers

Partially update a layer

patch/console/v1/layers/{id}

Path parameters

idstring required

id

Request body

descriptionstring

A detailed description of the layer, explaining its purpose and functionality.

Response

Partial update layer response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Layer updated successfully.",
  "data": {
    "id": "the_best_layer",
    "description": "new description",
    "idType": "userID",
    "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
    "lastModifiedTime": 1720734756985,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
    "createdTime": 1720733942515,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [
      "new fo"
    ],
    "holdoutIDs": [
      "global_holdout",
      "test_holdout"
    ],
    "tags": [],
    "team": "Console Team",
    "isImplicitLayer": false,
    "parameters": [
      {
        "name": "a_parameter",
        "type": "boolean",
        "defaultValue": true
      },
      {
        "name": "b_parameter",
        "type": "number",
        "defaultValue": 123
      },
      {
        "name": "c_parameter",
        "type": "string",
        "defaultValue": "this is a string"
      },
      {
        "name": "d_parameter",
        "type": "array",
        "defaultValue": []
      },
      {
        "name": "e_parameter",
        "type": "object",
        "defaultValue": {
          "key": "value"
        }
      }
    ],
    "targeting_gate_parameter_values": [],
    "holdout_parameter_values": [],
    "permalink": "https://console.statsig.com/company_id/layers/the_best_layer"
  }
}