Update a release template | Unleash Documentation

curl -X PUT https://app.unleash-instance.example.com/api/admin/release-plan-templates/templateId \
     -H "Authorization: <apiKey>"

{
  "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
  "discriminator": "template",
  "name": "My release plan",
  "createdByUserId": 53,
  "createdAt": "2022-01-01T00:00:00Z",
  "description": "This is my release plan",
  "milestones": [
    {
      "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
      "name": "My milestone",
      "sortOrder": 1,
      "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
      "startedAt": "2024-01-01T00:00:00.000Z",
      "transitionCondition": {
        "intervalMinutes": 30
      },
      "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
      "pausedAt": "2024-01-01T00:00:00.000Z",
      "strategies": [
        {
          "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
          "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
          "sortOrder": 9999,
          "name": "flexibleRollout",
          "strategyName": "flexibleRollout",
          "title": "Gradual Rollout 25-Prod",
          "parameters": {
            "groupId": "some_new",
            "rollout": "25",
            "stickiness": "sessionId"
          },
          "constraints": [
            {
              "contextName": "appName",
              "operator": "IN",
              "caseInsensitive": false,
              "inverted": false,
              "values": [
                "1",
                "2"
              ]
            }
          ],
          "variants": [
            {
              "name": "blue_group",
              "weight": 1,
              "weightType": "fix",
              "stickiness": "custom.context.field",
              "payload": {
                "type": "json",
                "value": "{\"color\": \"red\"}"
              }
            }
          ],
          "segments": [
            1,
            2
          ],
          "disabled": false
        }
      ]
    }
  ],
  "archivedAt": "2022-01-01T00:00:00Z"
}

Enterprise feature

Finds and updates a release template by the provided id. Will delete existing milestones and create new ones from the body

curl -X PUT https://app.unleash-instance.example.com/api/admin/release-plan-templates/templateId \
     -H "Authorization: <apiKey>"

{
  "id": "01JB9GGTGQYEQ9D40R17T3YVW2",
  "discriminator": "template",
  "name": "My release plan",
  "createdByUserId": 53,
  "createdAt": "2022-01-01T00:00:00Z",
  "description": "This is my release plan",
  "milestones": [
    {
      "id": "01JB9GGTGQYEQ9D40R17T3YVW1",
      "name": "My milestone",
      "sortOrder": 1,
      "releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
      "startedAt": "2024-01-01T00:00:00.000Z",
      "transitionCondition": {
        "intervalMinutes": 30
      },
      "progressionExecutedAt": "2024-01-01T00:00:00.000Z",
      "pausedAt": "2024-01-01T00:00:00.000Z",
      "strategies": [
        {
          "id": "01JB9GGTGQYEQ9D40R17T3YVW3",
          "milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
          "sortOrder": 9999,
          "name": "flexibleRollout",
          "strategyName": "flexibleRollout",
          "title": "Gradual Rollout 25-Prod",
          "parameters": {
            "groupId": "some_new",
            "rollout": "25",
            "stickiness": "sessionId"
          },
          "constraints": [
            {
              "contextName": "appName",
              "operator": "IN",
              "caseInsensitive": false,
              "inverted": false,
              "values": [
                "1",
                "2"
              ]
            }
          ],
          "variants": [
            {
              "name": "blue_group",
              "weight": 1,
              "weightType": "fix",
              "stickiness": "custom.context.field",
              "payload": {
                "type": "json",
                "value": "{\"color\": \"red\"}"
              }
            }
          ],
          "segments": [
            1,
            2
          ],
          "disabled": false
        }
      ]
    }
  ],
  "archivedAt": "2022-01-01T00:00:00Z"
}

Enterprise feature

Finds and updates a release template by the provided id. Will delete existing milestones and create new ones from the body

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

templateIdstringRequired

Response

#/components/schemas/releasePlanTemplateSchema

idstring

The release plan/template’s ID. Release template IDs are ulids.

discriminatorenum

A field to distinguish between release plans and release templates.

Allowed values:

namestring

The name of the release template.

createdByUserIddouble

Release template: The ID of the user who created this template.

createdAtstringformat: "date-time"

The date and time that the release template was created.

descriptionstring or null

A description of the release template.

milestoneslist of objects

A list of the milestones in this release template.

archivedAtstring or nullformat: "date-time"

The date and time that the release template was archived.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

$	curl -X PUT https://app.unleash-instance.example.com/api/admin/release-plan-templates/templateId \
>	-H "Authorization: <apiKey>"

1	{
2	"id": "01JB9GGTGQYEQ9D40R17T3YVW2",
3	"discriminator": "template",
4	"name": "My release plan",
5	"createdByUserId": 53,
6	"createdAt": "2022-01-01T00:00:00Z",
7	"description": "This is my release plan",
8	"milestones": [
9	{
10	"id": "01JB9GGTGQYEQ9D40R17T3YVW1",
11	"name": "My milestone",
12	"sortOrder": 1,
13	"releasePlanDefinitionId": "01JB9GGTGQYEQ9D40R17T3YVW2",
14	"startedAt": "2024-01-01T00:00:00.000Z",
15	"transitionCondition": {
16	"intervalMinutes": 30
17	},
18	"progressionExecutedAt": "2024-01-01T00:00:00.000Z",
19	"pausedAt": "2024-01-01T00:00:00.000Z",
20	"strategies": [
21	{
22	"id": "01JB9GGTGQYEQ9D40R17T3YVW3",
23	"milestoneId": "01JB9GGTGQYEQ9D40R17T3YVW1",
24	"sortOrder": 9999,
25	"name": "flexibleRollout",
26	"strategyName": "flexibleRollout",
27	"title": "Gradual Rollout 25-Prod",
28	"parameters": {
29	"groupId": "some_new",
30	"rollout": "25",
31	"stickiness": "sessionId"
32	},
33	"constraints": [
34	{
35	"contextName": "appName",
36	"operator": "IN",
37	"caseInsensitive": false,
38	"inverted": false,
39	"values": [
40	"1",
41	"2"
42	]
43	}
44	],
45	"variants": [
46	{
47	"name": "blue_group",
48	"weight": 1,
49	"weightType": "fix",
50	"stickiness": "custom.context.field",
51	"payload": {
52	"type": "json",
53	"value": "{\"color\": \"red\"}"
54	}
55	}
56	],
57	"segments": [
58	1,
59	2
60	],
61	"disabled": false
62	}
63	]
64	}
65	],
66	"archivedAt": "2022-01-01T00:00:00Z"
67	}