Update strategy segments

POST 
/api/admin/segments/strategies

Sets the segments of the strategy specified to be exactly the ones passed in the payload. Any segments that were used by the strategy before will be removed if they are not in the provided list of segments.

Request

application/json

Body

required

updateFeatureStrategySegmentsSchema

projectId stringrequired
The ID of the project that the strategy belongs to.
Example: red-vista
strategyId stringrequired
The ID of the strategy to update segments for.
Example: 15d1e20b-6310-4e17-a0c2-9fb84de3053a
environmentId stringrequired
The ID of the strategy environment.
Example: development
segmentIds integer[]required
The new list of segments (IDs) to use for this strategy. Any segments not in this list will be removed from the strategy.
Example: [1,5,6]

Responses

201

The resource was successfully created.

Response Headers

• location

  string

  The location of the newly created resource.

application/json

Schema

Schema

projectId stringrequired
The ID of the project that the strategy belongs to.
Example: red-vista
strategyId stringrequired
The ID of the strategy to update segments for.
Example: 15d1e20b-6310-4e17-a0c2-9fb84de3053a
environmentId stringrequired
The ID of the strategy environment.
Example: development
segmentIds integer[]required
The new list of segments (IDs) to use for this strategy. Any segments not in this list will be removed from the strategy.
Example: [1,5,6]

Example (from schema)

{
  "projectId": "red-vista",
  "strategyId": "15d1e20b-6310-4e17-a0c2-9fb84de3053a",
  "environmentId": "development",
  "segmentIds": [
    1,
    5,
    6
  ]
}

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ContentTypeerror
message string
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Loading...