For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
    • Insights Charts Beta
    • Insights Deployments Beta
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
      • POSTCreate view
      • DELDelete view
      • GETGet linked resources
      • GETGet linked views for a given resource
      • GETGet view
      • POSTLink resource
      • GETList views
      • DELUnlink resource
      • PATCHUpdate view
    • Webhooks
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewViews Beta

Update view

PATCH
/api/v2/projects/:projectKey/views/:viewKey
PATCH
/api/v2/projects/:projectKey/views/:viewKey
$curl -X PATCH https://app.launchdarkly.com/api/v2/projects/default/views/my-view \
>     -H "LD-API-Version: beta" \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "name",
>  "description": "description",
>  "maintainerId": "maintainerId",
>  "maintainerTeamKey": "maintainerTeamKey",
>  "tags": [
>    "tags",
>    "tags"
>  ],
>  "archived": true
>}'
1{
2  "id": "id",
3  "accountId": "accountId",
4  "projectId": "projectId",
5  "projectKey": "projectKey",
6  "key": "key",
7  "name": "name",
8  "description": "description",
9  "_affectsSdkPayload": true,
10  "version": 0,
11  "tags": [
12    "tags",
13    "tags"
14  ],
15  "createdAt": 6,
16  "updatedAt": 1,
17  "archived": false,
18  "deleted": false,
19  "_access": {
20    "allowed": [
21      {
22        "action": "action",
23        "reason": {
24          "effect": "allow",
25          "resources": [
26            "proj/*:env/*;qa_*:/flag/*"
27          ],
28          "notResources": [
29            "notResources",
30            "notResources"
31          ],
32          "actions": [
33            "*"
34          ],
35          "notActions": [
36            "string",
37            "string"
38          ],
39          "role_name": "role_name"
40        }
41      },
42      {
43        "action": "action",
44        "reason": {
45          "effect": "allow",
46          "resources": [
47            "proj/*:env/*;qa_*:/flag/*"
48          ],
49          "notResources": [
50            "notResources",
51            "notResources"
52          ],
53          "actions": [
54            "*"
55          ],
56          "notActions": [
57            "string",
58            "string"
59          ],
60          "role_name": "role_name"
61        }
62      }
63    ],
64    "denied": [
65      {
66        "action": "action",
67        "reason": {
68          "effect": "allow",
69          "resources": [
70            "proj/*:env/*;qa_*:/flag/*"
71          ],
72          "notResources": [
73            "notResources",
74            "notResources"
75          ],
76          "actions": [
77            "*"
78          ],
79          "notActions": [
80            "string",
81            "string"
82          ],
83          "role_name": "role_name"
84        }
85      },
86      {
87        "action": "action",
88        "reason": {
89          "effect": "allow",
90          "resources": [
91            "proj/*:env/*;qa_*:/flag/*"
92          ],
93          "notResources": [
94            "notResources",
95            "notResources"
96          ],
97          "actions": [
98            "*"
99          ],
100          "notActions": [
101            "string",
102            "string"
103          ],
104          "role_name": "role_name"
105        }
106      }
107    ]
108  },
109  "_links": {
110    "self": {
111      "href": "href",
112      "type": "type"
113    },
114    "parent": {
115      "href": "href",
116      "type": "type"
117    }
118  },
119  "archivedAt": 5,
120  "deletedAt": 5,
121  "maintainer": {
122    "id": "id",
123    "kind": "kind",
124    "maintainerMember": {
125      "id": "id",
126      "email": "email",
127      "role": "role",
128      "firstName": "firstName",
129      "lastName": "lastName"
130    },
131    "maintainerTeam": {
132      "id": "id",
133      "key": "key",
134      "name": "name"
135    }
136  },
137  "flagsSummary": {
138    "count": 2,
139    "linkedFlags": {
140      "items": [
141        {
142          "key": "key",
143          "name": "name",
144          "links": {
145            "self": {
146              "href": "href",
147              "type": "type"
148            }
149          }
150        },
151        {
152          "key": "key",
153          "name": "name",
154          "links": {
155            "self": {
156              "href": "href",
157              "type": "type"
158            }
159          }
160        }
161      ],
162      "totalCount": 7
163    }
164  },
165  "segmentsSummary": {
166    "count": 9,
167    "linkedSegments": {
168      "items": [
169        {
170          "key": "key",
171          "name": "name",
172          "environmentId": "environmentId",
173          "links": {
174            "self": {
175              "href": "href",
176              "type": "type"
177            }
178          }
179        },
180        {
181          "key": "key",
182          "name": "name",
183          "environmentId": "environmentId",
184          "links": {
185            "self": {
186              "href": "href",
187              "type": "type"
188            }
189          }
190        }
191      ],
192      "totalCount": 3
193    }
194  },
195  "metricsSummary": {
196    "count": 2
197  },
198  "aiConfigsSummary": {
199    "count": 4
200  },
201  "resourceSummary": {
202    "flagCount": 7,
203    "totalCount": 6,
204    "segmentCount": 1,
205    "metricCount": 1,
206    "aiConfigCount": 1
207  },
208  "flagsExpanded": {
209    "items": [
210      {
211        "key": "key",
212        "name": "name",
213        "description": "description",
214        "creationDate": 7,
215        "_version": 1,
216        "archived": true,
217        "tags": [
218          "tags",
219          "tags"
220        ],
221        "temporary": true,
222        "includeInSnippet": true,
223        "maintainer": {
224          "key": "key",
225          "kind": "member",
226          "_member": {
227            "_links": {
228              "self": {
229                "href": "/api/v2/members/569f183514f4432160000007",
230                "type": "application/json"
231              }
232            },
233            "_id": "569f183514f4432160000007",
234            "role": "admin",
235            "email": "ariel@acme.com",
236            "firstName": "Ariel",
237            "lastName": "Flores"
238          },
239          "_team": {
240            "customRoleKeys": [
241              "access-to-test-projects"
242            ],
243            "key": "team-key-123abc",
244            "name": "QA Team",
245            "_links": {
246              "key": {
247                "href": "href",
248                "type": "type"
249              }
250            }
251          }
252        },
253        "_links": {
254          "self": {
255            "href": "href",
256            "type": "type"
257          },
258          "parent": {
259            "href": "href",
260            "type": "type"
261          }
262        }
263      },
264      {
265        "key": "key",
266        "name": "name",
267        "description": "description",
268        "creationDate": 7,
269        "_version": 1,
270        "archived": true,
271        "tags": [
272          "tags",
273          "tags"
274        ],
275        "temporary": true,
276        "includeInSnippet": true,
277        "maintainer": {
278          "key": "key",
279          "kind": "member",
280          "_member": {
281            "_links": {
282              "self": {
283                "href": "/api/v2/members/569f183514f4432160000007",
284                "type": "application/json"
285              }
286            },
287            "_id": "569f183514f4432160000007",
288            "role": "admin",
289            "email": "ariel@acme.com",
290            "firstName": "Ariel",
291            "lastName": "Flores"
292          },
293          "_team": {
294            "customRoleKeys": [
295              "access-to-test-projects"
296            ],
297            "key": "team-key-123abc",
298            "name": "QA Team",
299            "_links": {
300              "key": {
301                "href": "href",
302                "type": "type"
303              }
304            }
305          }
306        },
307        "_links": {
308          "self": {
309            "href": "href",
310            "type": "type"
311          },
312          "parent": {
313            "href": "href",
314            "type": "type"
315          }
316        }
317      }
318    ],
319    "totalCount": 4
320  },
321  "segmentsExpanded": {
322    "items": [
323      {
324        "key": "key",
325        "name": "name",
326        "environmentId": "environmentId",
327        "environmentKey": "environmentKey",
328        "description": "description",
329        "creationDate": 5,
330        "lastModifiedDate": 9,
331        "deleted": true,
332        "tags": [
333          "tags",
334          "tags"
335        ],
336        "unbounded": true,
337        "version": 9,
338        "generation": 6,
339        "_links": {
340          "self": {
341            "href": "href",
342            "type": "type"
343          },
344          "parent": {
345            "href": "href",
346            "type": "type"
347          }
348        }
349      },
350      {
351        "key": "key",
352        "name": "name",
353        "environmentId": "environmentId",
354        "environmentKey": "environmentKey",
355        "description": "description",
356        "creationDate": 5,
357        "lastModifiedDate": 9,
358        "deleted": true,
359        "tags": [
360          "tags",
361          "tags"
362        ],
363        "unbounded": true,
364        "version": 9,
365        "generation": 6,
366        "_links": {
367          "self": {
368            "href": "href",
369            "type": "type"
370          },
371          "parent": {
372            "href": "href",
373            "type": "type"
374          }
375        }
376      }
377    ],
378    "totalCount": 8
379  },
380  "metricsExpanded": {
381    "items": [
382      {
383        "key": "key",
384        "name": "name",
385        "creationDate": 9,
386        "lastModified": 6,
387        "isActive": true,
388        "eventKey": "eventKey",
389        "_id": "_id",
390        "_versionId": "_versionId",
391        "kind": "kind",
392        "category": "category",
393        "description": "description",
394        "isNumeric": true,
395        "lastSeen": 3,
396        "_links": {
397          "self": {
398            "href": "href",
399            "type": "type"
400          },
401          "parent": {
402            "href": "href",
403            "type": "type"
404          }
405        }
406      },
407      {
408        "key": "key",
409        "name": "name",
410        "creationDate": 9,
411        "lastModified": 6,
412        "isActive": true,
413        "eventKey": "eventKey",
414        "_id": "_id",
415        "_versionId": "_versionId",
416        "kind": "kind",
417        "category": "category",
418        "description": "description",
419        "isNumeric": true,
420        "lastSeen": 3,
421        "_links": {
422          "self": {
423            "href": "href",
424            "type": "type"
425          },
426          "parent": {
427            "href": "href",
428            "type": "type"
429          }
430        }
431      }
432    ],
433    "totalCount": 6
434  },
435  "aiConfigsExpanded": {
436    "items": [
437      {
438        "key": "key",
439        "name": "name",
440        "tags": [
441          "tags",
442          "tags"
443        ],
444        "description": "description",
445        "version": 1,
446        "createdAt": 2,
447        "updatedAt": 6,
448        "flagKey": "flagKey",
449        "_links": {
450          "self": {
451            "href": "href",
452            "type": "type"
453          },
454          "parent": {
455            "href": "href",
456            "type": "type"
457          }
458        }
459      },
460      {
461        "key": "key",
462        "name": "name",
463        "tags": [
464          "tags",
465          "tags"
466        ],
467        "description": "description",
468        "version": 1,
469        "createdAt": 2,
470        "updatedAt": 6,
471        "flagKey": "flagKey",
472        "_links": {
473          "self": {
474            "href": "href",
475            "type": "type"
476          },
477          "parent": {
478            "href": "href",
479            "type": "type"
480          }
481        }
482      }
483    ],
484    "totalCount": 6
485  },
486  "resourcesExpanded": {
487    "items": {
488      "flags": {
489        "items": [
490          {
491            "key": "key",
492            "name": "name",
493            "description": "description",
494            "creationDate": 7,
495            "_version": 1,
496            "archived": true,
497            "tags": [
498              "tags",
499              "tags"
500            ],
501            "temporary": true,
502            "includeInSnippet": true,
503            "maintainer": {
504              "key": "key",
505              "kind": "member",
506              "_member": {
507                "_links": {
508                  "self": {
509                    "href": "/api/v2/members/569f183514f4432160000007",
510                    "type": "application/json"
511                  }
512                },
513                "_id": "569f183514f4432160000007",
514                "role": "admin",
515                "email": "ariel@acme.com",
516                "firstName": "Ariel",
517                "lastName": "Flores"
518              },
519              "_team": {
520                "customRoleKeys": [
521                  "access-to-test-projects"
522                ],
523                "key": "team-key-123abc",
524                "name": "QA Team",
525                "_links": {
526                  "key": {
527                    "href": "href",
528                    "type": "type"
529                  }
530                }
531              }
532            },
533            "_links": {
534              "self": {
535                "href": "href",
536                "type": "type"
537              },
538              "parent": {
539                "href": "href",
540                "type": "type"
541              }
542            }
543          },
544          {
545            "key": "key",
546            "name": "name",
547            "description": "description",
548            "creationDate": 7,
549            "_version": 1,
550            "archived": true,
551            "tags": [
552              "tags",
553              "tags"
554            ],
555            "temporary": true,
556            "includeInSnippet": true,
557            "maintainer": {
558              "key": "key",
559              "kind": "member",
560              "_member": {
561                "_links": {
562                  "self": {
563                    "href": "/api/v2/members/569f183514f4432160000007",
564                    "type": "application/json"
565                  }
566                },
567                "_id": "569f183514f4432160000007",
568                "role": "admin",
569                "email": "ariel@acme.com",
570                "firstName": "Ariel",
571                "lastName": "Flores"
572              },
573              "_team": {
574                "customRoleKeys": [
575                  "access-to-test-projects"
576                ],
577                "key": "team-key-123abc",
578                "name": "QA Team",
579                "_links": {
580                  "key": {
581                    "href": "href",
582                    "type": "type"
583                  }
584                }
585              }
586            },
587            "_links": {
588              "self": {
589                "href": "href",
590                "type": "type"
591              },
592              "parent": {
593                "href": "href",
594                "type": "type"
595              }
596            }
597          }
598        ],
599        "totalCount": 5
600      },
601      "segments": {
602        "items": [
603          {
604            "key": "key",
605            "name": "name",
606            "environmentId": "environmentId",
607            "environmentKey": "environmentKey",
608            "description": "description",
609            "creationDate": 5,
610            "lastModifiedDate": 9,
611            "deleted": true,
612            "tags": [
613              "tags",
614              "tags"
615            ],
616            "unbounded": true,
617            "version": 9,
618            "generation": 6,
619            "_links": {
620              "self": {
621                "href": "href",
622                "type": "type"
623              },
624              "parent": {
625                "href": "href",
626                "type": "type"
627              }
628            }
629          },
630          {
631            "key": "key",
632            "name": "name",
633            "environmentId": "environmentId",
634            "environmentKey": "environmentKey",
635            "description": "description",
636            "creationDate": 5,
637            "lastModifiedDate": 9,
638            "deleted": true,
639            "tags": [
640              "tags",
641              "tags"
642            ],
643            "unbounded": true,
644            "version": 9,
645            "generation": 6,
646            "_links": {
647              "self": {
648                "href": "href",
649                "type": "type"
650              },
651              "parent": {
652                "href": "href",
653                "type": "type"
654              }
655            }
656          }
657        ],
658        "totalCount": 6
659      },
660      "aiConfigs": {
661        "totalCount": 3,
662        "items": [
663          {
664            "createdAt": 2,
665            "_links": {
666              "parent": {
667                "href": "href",
668                "type": "type"
669              },
670              "self": {
671                "href": "href",
672                "type": "type"
673              }
674            },
675            "name": "name",
676            "description": "description",
677            "version": 1,
678            "key": "key",
679            "flagKey": "flagKey",
680            "tags": [
681              "tags",
682              "tags"
683            ],
684            "updatedAt": 6
685          },
686          {
687            "createdAt": 2,
688            "_links": {
689              "parent": {
690                "href": "href",
691                "type": "type"
692              },
693              "self": {
694                "href": "href",
695                "type": "type"
696              }
697            },
698            "name": "name",
699            "description": "description",
700            "version": 1,
701            "key": "key",
702            "flagKey": "flagKey",
703            "tags": [
704              "tags",
705              "tags"
706            ],
707            "updatedAt": 6
708          }
709        ]
710      },
711      "metrics": {
712        "totalCount": 3,
713        "items": [
714          {
715            "_links": {
716              "parent": {
717                "href": "href",
718                "type": "type"
719              },
720              "self": {
721                "href": "href",
722                "type": "type"
723              }
724            },
725            "kind": "kind",
726            "description": "description",
727            "creationDate": 9,
728            "isActive": true,
729            "lastSeen": 3,
730            "eventKey": "eventKey",
731            "_versionId": "_versionId",
732            "isNumeric": true,
733            "name": "name",
734            "lastModified": 6,
735            "_id": "_id",
736            "category": "category",
737            "key": "key"
738          },
739          {
740            "_links": {
741              "parent": {
742                "href": "href",
743                "type": "type"
744              },
745              "self": {
746                "href": "href",
747                "type": "type"
748              }
749            },
750            "kind": "kind",
751            "description": "description",
752            "creationDate": 9,
753            "isActive": true,
754            "lastSeen": 3,
755            "eventKey": "eventKey",
756            "_versionId": "_versionId",
757            "isNumeric": true,
758            "name": "name",
759            "lastModified": 6,
760            "_id": "_id",
761            "category": "category",
762            "key": "key"
763          }
764        ]
765      }
766    },
767    "totalCount": 7
768  },
769  "generateSdkKeys": true
770}
Edit an existing view. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here's an example: ``` { "description": "Example updated description", "tags": ["new-tag"] } ```
Was this page helpful?
Previous

Webhooks

Next
Built with

Edit an existing view.

The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields.

Here’s an example:

  {
    "description": "Example updated description",
    "tags": ["new-tag"]
  }

Authentication

Authorizationstring
API Key authentication via header

Path parameters

projectKeystringRequired
viewKeystringRequired

Headers

LD-API-VersionenumRequired
Version of the endpoint.
Allowed values:

Request

A JSON representation of the view including only the fields to update.
namestringOptional

Human-readable name for the view

descriptionstringOptional
Optional detailed description of the view
maintainerIdstringOptional

Member ID of the maintainer for this view. Only one of maintainerId or maintainerTeamKey can be specified.

maintainerTeamKeystringOptional

Key of the maintainer team for this view. Only one of maintainerId or maintainerTeamKey can be specified.

tagslist of stringsOptional
Tags associated with this view
archivedbooleanOptional
Whether or not the view is archived

Response

Successful response
idstringformat: "string"
Unique ID of this view
accountIdstring
ID of the account that owns this view
projectIdstring
ID of the project this view belongs to
projectKeystring
Key of the project this view belongs to
keystring

Unique key for the view within the account/project

namestring

Human-readable name for the view

descriptionstring
Optional detailed description of the view
_affectsSdkPayloadboolean
Whether this view is used to filter SDK payloads
versioninteger
Version number for tracking changes
tagslist of strings
Tags associated with this view
createdAtlong
updatedAtlong
archivedbooleanDefaults to false
Whether this view is archived
deletedbooleanDefaults to false
Whether this view is deleted
_accessobject
_linksobject
The location and content type of related resources
archivedAtlong
deletedAtlong
maintainerobject
flagsSummaryobject
segmentsSummaryobject
metricsSummaryobject
aiConfigsSummaryobject
resourceSummaryobject
flagsExpandedobject

Details on linked flags for a view - requires passing the ‘allFlags’ expand field

segmentsExpandedobject

Details on linked segments for a view - requires passing the ‘allSegments’ expand field

metricsExpandedobject
aiConfigsExpandedobject
resourcesExpandedobject

Details on linked resources for a view - requires passing the ‘allResources’ expand field

generateSdkKeysbooleanRead-onlyDeprecated

Deprecated compatibility field. Mirrors _affectsSdkPayload during rollout.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error