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 string required

  The ID of the project that the strategy belongs to.

• strategyId string required

  The ID of the strategy to update segments for.

• environmentId string required

  The ID of the strategy environment.

• 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.

Responses

• 201
• 400
• 401
• 403
• 415

---

The resource was successfully created.

Response Headers

• location string

  The location of the newly created resource.

application/json

Schema

Schema

• projectId string required

  The ID of the project that the strategy belongs to.

• strategyId string required

  The ID of the strategy to update segments for.

• environmentId string required

  The ID of the strategy environment.

• 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 (from schema)

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

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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 []."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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...