Publish a draft revision

Publishes the draft and applies its changes to the live Saved Group. The caller needs Publish access in every assigned Project. When approval is required, the draft must be approved unless the caller has Bypass draft approvals access. If the organization requires rebasing, an out-of-date draft must be rebased first; an authorized caller can instead send ignoreWarnings: true to force-publish it. A 422 response lists every blocking gate and the available resolution.

POST

saved-groups-revisions

{savedGroupId}

{version}

publish

cURL

curl -X POST 'https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish"

payload = {
    "bypassApproval": True,
    "ignoreWarnings": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({bypassApproval: true, ignoreWarnings: true})
};

fetch('https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bypassApproval' => true,
    'ignoreWarnings' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish"

	payload := strings.NewReader("{\n  \"bypassApproval\": true,\n  \"ignoreWarnings\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bypassApproval\": true,\n  \"ignoreWarnings\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bypassApproval\": true,\n  \"ignoreWarnings\": true\n}"

response = http.request(request)
puts response.read_body

{
  "revision": {
    "id": "<string>",
    "status": "draft",
    "authorId": "<string>",
    "reviews": [
      {
        "id": "<string>",
        "userId": "<string>",
        "decision": "approve",
        "dateCreated": "2023-11-07T05:31:56Z",
        "comment": "<string>",
        "stale": true
      }
    ],
    "activityLog": [
      {
        "id": "<string>",
        "userId": "<string>",
        "action": "created",
        "dateCreated": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "proposedChangesSnapshot": [
          {
            "op": "add",
            "path": "<string>",
            "value": "<unknown>"
          }
        ],
        "targetSnapshot": "<unknown>"
      }
    ],
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "baseSavedGroup": {
      "id": "<string>",
      "type": "condition",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "owner": "<string>",
      "ownerEmail": "<string>",
      "condition": "<string>",
      "attributeKey": "<string>",
      "values": [
        "<string>"
      ],
      "description": "<string>",
      "projects": [
        "<string>"
      ],
      "archived": true,
      "useEmptyListGroup": true
    },
    "proposedSavedGroup": {
      "id": "<string>",
      "type": "condition",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "owner": "<string>",
      "ownerEmail": "<string>",
      "condition": "<string>",
      "attributeKey": "<string>",
      "values": [
        "<string>"
      ],
      "description": "<string>",
      "projects": [
        "<string>"
      ],
      "archived": true,
      "useEmptyListGroup": true
    },
    "proposedChanges": [
      {
        "op": "add",
        "path": "<string>",
        "value": "<unknown>"
      }
    ],
    "version": 123,
    "title": "<string>",
    "authorEmail": "<string>",
    "contributors": [
      "<string>"
    ],
    "revertedFrom": "<string>",
    "autoPublishOnApproval": true,
    "autoPublishEnabledBy": "<string>",
    "scheduledPublishAt": "2023-11-07T05:31:56Z",
    "scheduledPublishLockEdits": true,
    "scheduledPublishLockOthers": true,
    "scheduledPublishBypassApproval": true,
    "scheduledPublishAttempts": 123,
    "scheduledPublishLastError": "<string>",
    "scheduledPublishGaveUpAt": "2023-11-07T05:31:56Z",
    "resolution": {
      "action": "merged",
      "userId": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z"
    }
  },
  "bypassedGates": [
    {
      "type": "<string>",
      "outcome": "bypassed",
      "via": "ignoreWarnings"
    }
  ]
}

Authorizations

Authorization

string

header

required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1/features   -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

savedGroupId

string

required

version

integer

required

Body

application/json

bypassApproval

boolean

Deprecated and ignored. Approval is bypassed automatically when the caller has Bypass draft approvals access for this resource or when the organization enables the REST API approval bypass. Otherwise, the revision must be approved before it can be published.

ignoreWarnings

boolean

Set to true to acknowledge the warnings listed in a blocked response and continue. This covers experiment guards, locked dependents, and references affected by an archive. When the organization treats schema failures as warnings, it also covers schema and invariant warnings. It never bypasses a rejected Custom Hook. On revision publish endpoints, it can also force-publish an out-of-date draft when the caller has Bypass draft approvals access.

Response

200 - application/json

Resource created

revision

object

required

Show child attributes

bypassedGates

object[]

Gates that would have blocked this publish but were bypassed by the caller's authority. Present only when at least one gate was bypassed.

Show child attributes

cURL

curl -X POST 'https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish"

payload = {
    "bypassApproval": True,
    "ignoreWarnings": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({bypassApproval: true, ignoreWarnings: true})
};

fetch('https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bypassApproval' => true,
    'ignoreWarnings' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish"

	payload := strings.NewReader("{\n  \"bypassApproval\": true,\n  \"ignoreWarnings\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bypassApproval\": true,\n  \"ignoreWarnings\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/saved-groups-revisions/{savedGroupId}/{version}/publish")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bypassApproval\": true,\n  \"ignoreWarnings\": true\n}"

response = http.request(request)
puts response.read_body

{
  "revision": {
    "id": "<string>",
    "status": "draft",
    "authorId": "<string>",
    "reviews": [
      {
        "id": "<string>",
        "userId": "<string>",
        "decision": "approve",
        "dateCreated": "2023-11-07T05:31:56Z",
        "comment": "<string>",
        "stale": true
      }
    ],
    "activityLog": [
      {
        "id": "<string>",
        "userId": "<string>",
        "action": "created",
        "dateCreated": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "proposedChangesSnapshot": [
          {
            "op": "add",
            "path": "<string>",
            "value": "<unknown>"
          }
        ],
        "targetSnapshot": "<unknown>"
      }
    ],
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "baseSavedGroup": {
      "id": "<string>",
      "type": "condition",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "owner": "<string>",
      "ownerEmail": "<string>",
      "condition": "<string>",
      "attributeKey": "<string>",
      "values": [
        "<string>"
      ],
      "description": "<string>",
      "projects": [
        "<string>"
      ],
      "archived": true,
      "useEmptyListGroup": true
    },
    "proposedSavedGroup": {
      "id": "<string>",
      "type": "condition",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "owner": "<string>",
      "ownerEmail": "<string>",
      "condition": "<string>",
      "attributeKey": "<string>",
      "values": [
        "<string>"
      ],
      "description": "<string>",
      "projects": [
        "<string>"
      ],
      "archived": true,
      "useEmptyListGroup": true
    },
    "proposedChanges": [
      {
        "op": "add",
        "path": "<string>",
        "value": "<unknown>"
      }
    ],
    "version": 123,
    "title": "<string>",
    "authorEmail": "<string>",
    "contributors": [
      "<string>"
    ],
    "revertedFrom": "<string>",
    "autoPublishOnApproval": true,
    "autoPublishEnabledBy": "<string>",
    "scheduledPublishAt": "2023-11-07T05:31:56Z",
    "scheduledPublishLockEdits": true,
    "scheduledPublishLockOthers": true,
    "scheduledPublishBypassApproval": true,
    "scheduledPublishAttempts": 123,
    "scheduledPublishLastError": "<string>",
    "scheduledPublishGaveUpAt": "2023-11-07T05:31:56Z",
    "resolution": {
      "action": "merged",
      "userId": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z"
    }
  },
  "bypassedGates": [
    {
      "type": "<string>",
      "outcome": "bypassed",
      "via": "ignoreWarnings"
    }
  ]
}

Introduction

Endpoints

Models

Publish a draft revision

Authorizations

Path Parameters

Body

Response