Update a strategy type

PUT 
https://us.app.unleash-hosted.com/ushosted/api/admin/strategies/:name

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

Request

Path Parameters

name stringrequired

application/json

Body

required

updateStrategySchema

description string
A description of the strategy type.
Example: Enable the feature for users who have not logged in before.

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 stringrequired

The name of the parameter

Example: Rollout percentage

type stringrequired

The type of the parameter

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

Example: percentage

description string

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

Example: How many percent of users should see this feature?

required boolean

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

Example: false

]

Responses

200

This response has no body.

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

404

The requested resource was not found.

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: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

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

Authorization: Authorization

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://us.app.unleash-hosted.com/ushosted/api/admin/strategies/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
  "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
    }
  ]
}'

Request Collapse all

Base URL

https://us.app.unleash-hosted.com/ushosted

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

name — pathrequired

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
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!