Create segment

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example segment",
  "key": "segment-key-123abc",
  "description": "Bundle our sample customers together",
  "tags": [
    "testing"
  ],
  "unbounded": false,
  "unboundedContextKind": "device"
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

payload = {
    "name": "Example segment",
    "key": "segment-key-123abc",
    "description": "Bundle our sample customers together",
    "tags": ["testing"],
    "unbounded": False,
    "unboundedContextKind": "device"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Example segment',
    key: 'segment-key-123abc',
    description: 'Bundle our sample customers together',
    tags: ['testing'],
    unbounded: false,
    unboundedContextKind: 'device'
  })
};

fetch('https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}', 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://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}",
  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([
    'name' => 'Example segment',
    'key' => 'segment-key-123abc',
    'description' => 'Bundle our sample customers together',
    'tags' => [
        'testing'
    ],
    'unbounded' => false,
    'unboundedContextKind' => 'device'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

	payload := strings.NewReader("{\n  \"name\": \"Example segment\",\n  \"key\": \"segment-key-123abc\",\n  \"description\": \"Bundle our sample customers together\",\n  \"tags\": [\n    \"testing\"\n  ],\n  \"unbounded\": false,\n  \"unboundedContextKind\": \"device\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Example segment\",\n  \"key\": \"segment-key-123abc\",\n  \"description\": \"Bundle our sample customers together\",\n  \"tags\": [\n    \"testing\"\n  ],\n  \"unbounded\": false,\n  \"unboundedContextKind\": \"device\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Example segment\",\n  \"key\": \"segment-key-123abc\",\n  \"description\": \"Bundle our sample customers together\",\n  \"tags\": [\n    \"testing\"\n  ],\n  \"unbounded\": false,\n  \"unboundedContextKind\": \"device\"\n}"

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

{
  "name": "Example segment",
  "tags": [
    "testing"
  ],
  "creationDate": "1654104600000",
  "lastModifiedDate": "1654104600000",
  "key": "segment-key-123abc",
  "_links": {},
  "rules": [
    {
      "_id": "1234a56b7c89d012345e678f",
      "clauses": [
        {
          "_id": "12ab3c45de678910fab12345",
          "attribute": "email",
          "negate": false,
          "op": "endsWith",
          "values": [
            ".edu"
          ]
        }
      ]
    }
  ],
  "version": 1,
  "deleted": false,
  "generation": 123,
  "description": "Bundle our sample customers together",
  "included": [
    "user-key-123abc"
  ],
  "excluded": [
    "user-key-123abc"
  ],
  "includedContexts": [
    {
      "values": [
        "<string>"
      ],
      "contextKind": "<string>"
    }
  ],
  "excludedContexts": [
    {
      "values": [
        "<string>"
      ],
      "contextKind": "<string>"
    }
  ],
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "_flags": [
    {
      "name": "Example flag",
      "key": "flag-key-123abc",
      "_links": {},
      "_site": {
        "href": "<string>",
        "type": "<string>"
      }
    }
  ],
  "unbounded": false,
  "unboundedContextKind": "<string>",
  "_unboundedMetadata": {
    "envId": "<string>",
    "segmentId": "<string>",
    "version": 123,
    "includedCount": 123,
    "excludedCount": 123,
    "lastModified": 123,
    "deleted": true
  },
  "_external": "amplitude",
  "_externalLink": "https://analytics.amplitude.com/org/1234/cohort/123abc",
  "_importInProgress": false
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Create segment

Create a new segment. The new segment has no individual targets or rules.

The request body only accepts the fields documented below. If you include targeting fields such as included, excluded, includedContexts, excludedContexts, or rules, LaunchDarkly ignores them and does not return an error. These fields are empty in the response.

To add individual targets or rules after you create the segment, use Update segment with a semantic patch. For example, use the addIncludedTargets or addExcludedTargets instruction to add individual targets, and the addRule instruction to add a rule. For big segments, use the addBigSegmentIncludedTargets or addBigSegmentExcludedTargets instruction.

POST

api

segments

{projectKey}

{environmentKey}

Create segment

curl --request POST \
  --url https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example segment",
  "key": "segment-key-123abc",
  "description": "Bundle our sample customers together",
  "tags": [
    "testing"
  ],
  "unbounded": false,
  "unboundedContextKind": "device"
}
'

import requests

url = "https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

payload = {
    "name": "Example segment",
    "key": "segment-key-123abc",
    "description": "Bundle our sample customers together",
    "tags": ["testing"],
    "unbounded": False,
    "unboundedContextKind": "device"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Example segment',
    key: 'segment-key-123abc',
    description: 'Bundle our sample customers together',
    tags: ['testing'],
    unbounded: false,
    unboundedContextKind: 'device'
  })
};

fetch('https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}', 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://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}",
  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([
    'name' => 'Example segment',
    'key' => 'segment-key-123abc',
    'description' => 'Bundle our sample customers together',
    'tags' => [
        'testing'
    ],
    'unbounded' => false,
    'unboundedContextKind' => 'device'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}"

	payload := strings.NewReader("{\n  \"name\": \"Example segment\",\n  \"key\": \"segment-key-123abc\",\n  \"description\": \"Bundle our sample customers together\",\n  \"tags\": [\n    \"testing\"\n  ],\n  \"unbounded\": false,\n  \"unboundedContextKind\": \"device\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Example segment\",\n  \"key\": \"segment-key-123abc\",\n  \"description\": \"Bundle our sample customers together\",\n  \"tags\": [\n    \"testing\"\n  ],\n  \"unbounded\": false,\n  \"unboundedContextKind\": \"device\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/segments/{projectKey}/{environmentKey}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Example segment\",\n  \"key\": \"segment-key-123abc\",\n  \"description\": \"Bundle our sample customers together\",\n  \"tags\": [\n    \"testing\"\n  ],\n  \"unbounded\": false,\n  \"unboundedContextKind\": \"device\"\n}"

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

{
  "name": "Example segment",
  "tags": [
    "testing"
  ],
  "creationDate": "1654104600000",
  "lastModifiedDate": "1654104600000",
  "key": "segment-key-123abc",
  "_links": {},
  "rules": [
    {
      "_id": "1234a56b7c89d012345e678f",
      "clauses": [
        {
          "_id": "12ab3c45de678910fab12345",
          "attribute": "email",
          "negate": false,
          "op": "endsWith",
          "values": [
            ".edu"
          ]
        }
      ]
    }
  ],
  "version": 1,
  "deleted": false,
  "generation": 123,
  "description": "Bundle our sample customers together",
  "included": [
    "user-key-123abc"
  ],
  "excluded": [
    "user-key-123abc"
  ],
  "includedContexts": [
    {
      "values": [
        "<string>"
      ],
      "contextKind": "<string>"
    }
  ],
  "excludedContexts": [
    {
      "values": [
        "<string>"
      ],
      "contextKind": "<string>"
    }
  ],
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "_flags": [
    {
      "name": "Example flag",
      "key": "flag-key-123abc",
      "_links": {},
      "_site": {
        "href": "<string>",
        "type": "<string>"
      }
    }
  ],
  "unbounded": false,
  "unboundedContextKind": "<string>",
  "_unboundedMetadata": {
    "envId": "<string>",
    "segmentId": "<string>",
    "version": 123,
    "includedCount": 123,
    "excludedCount": 123,
    "lastModified": 123,
    "deleted": true
  },
  "_external": "amplitude",
  "_externalLink": "https://analytics.amplitude.com/org/1234/cohort/123abc",
  "_importInProgress": false
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Scopes

read

write

Path Parameters

projectKey

string<string>

required

The project key

environmentKey

string<string>

required

The environment key

Body

application/json

name

string

required

A human-friendly name for the segment

Example:

"Example segment"

key

string

required

A unique key used to reference the segment

Example:

"segment-key-123abc"

description

string

A description of the segment's purpose

Example:

"Bundle our sample customers together"

Response

Segment response

name

string

required

A human-friendly name for the segment.

Example:

"Example segment"