Create Segment

Create a segment in your account (for a given traffic type). This API does not configure the segment in any FME environment. Include the segment details in the JSON body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_SEGMENT_EDITOR

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE


To learn more about Admin API Key roles and scopes, see API keys overview.


JSON Payload Posted

{
 "name": String, // Mandatory
 "description": String, // Optional
 "owners": [ // Optional
      {
        "id": String,
        "type": String
      }
    ]
}

Note: Owners are treated as metadata to help identify responsible stakeholders and filter feature flags. Owners are not automatically granted edit permissions. To manage who can edit a resource, use environment-level permissions or configure explicit editors.

The owners field specifies users or teams responsible for the feature flag. Each owner object requires an id and a type.

  • type must either be User or Team.
  • id must correspond to an existing user or team in the project (or workspace).
  • The _project_all_users team ID represents the All Project Users owner available in the FME UI.

For example:

{
  "name": "premier_status_members",
  "description": "description",
  "owners": [
    {
      "id": "EvGB7BeOTAWilAUxLcFlgA",
      "type": "User"
    },
    {
      "id": "_project_all_users",
      "type": "Team"
    }
  ]
}
Path Params
string
required

The ID of the project (workspace) where you want to create the segment. After migration to Harness, get this value using the Get Projects (Workspaces) endpoint and the Harness project name.

string
required

The ID or name of the traffic type, for example: user or account.

Form Data
json

JSON object that contains the name and (optionally) the description and owners of the segment.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json