Update a strategy type

PUT <your-unleash-url>/api/admin/strategies/:name

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Updates the specified strategy type. Any properties not specified in the request body are left untouched.

Request

Path Parameters

• name string required

application/json

Body

required

updateStrategySchema

• description string

  A description of the strategy type.

• parameters object[]required

  The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation.

  Array [

  name string required

  The name of the parameter

  type string required

  Possible values: [string, percentage, list, number, boolean]

  The type of the parameter

  description string

  A description of this strategy parameter. Use this to indicate to the users what the parameter does.

  required boolean

  Whether this parameter must be configured when using the strategy. Defaults to false

  ]

Responses

• 200
• 401
• 403
• 404
• 415

---

This response has no body.

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 requested resource was not found.

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": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

name — path required

Body required

{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}

curl / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

python / requests

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

go / native

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

nodejs / axios

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

ruby / Net::HTTP

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

csharp / RestSharp

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

php / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

java / OkHttp

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'

powershell / RestMethod

curl -L -X PUT '<your-unleash-url>/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "description": "Enable the feature for users who have not logged in before.",
  "parameters": [
    {
      "name": "Rollout percentage",
      "type": "percentage",
      "description": "How many percent of users should see this feature?",
      "required": false
    }
  ]
}'