Update segment by id | Unleash Documentation

Updates the content of the segment with the provided payload. Requires name and constraints to be present. If project is not present, it will be set to null. Any other fields not specified will be left untouched.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

idintegerRequired

a segment id

Request

upsertSegmentSchema

namestringRequired

The name of the segment

constraintslist of objectsRequired

The list of constraints that make up this segment

descriptionstring or nullOptional

A description of what the segment is for

projectstring or nullOptional

The project the segment belongs to if any.

Response

This response has no body.

1	import requests
2
3	url = "https://app.unleash-instance.example.com/api/admin/segments/1"
4
5	payload = {
6	"name": "beta-users",
7	"constraints": [
8	{
9	"contextName": "appName",
10	"operator": "IN"
11	}
12	]
13	}
14	headers = {
15	"Authorization": "<apiKey>",
16	"Content-Type": "application/json"
17	}
18
19	response = requests.put(url, json=payload, headers=headers)
20
21	print(response.json())

Authentication

Path parameters

Request

Response

Errors