Update a deployment
PUThttps://api.freemius.com/v1/products/{product_id}/tags/{tag_id}.json
Auth:Bearer TokenSCOPE: PRODUCT
Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need.
- Go to the Freemius Developer Dashboard.
- Open the Settings page of the relevant product.
- Click the API & Keys tab.
- Copy the API Bearer Authorization Token from the UI.
Update a specific deployed version of the product. This applies to WordPress products only. Use this endpoint to update the release_mode of a deployment to make it available to your customers.
Release Modes
Defined by the release_mode property, with the following possible values:
pending– The deployment is pending and not visible to customers. This is the default value.beta– The deployment is in beta mode. Only customers with beta access will see this version.released– The deployment is released and visible to all customers.
Additionally, WordPress plugins and themes support incremental releases and staged rollouts:
- Incremental Release: Controlled via the
is_incrementalflag, incremental releases enforce sequential updates, requiring users to install designated intermediate versions before proceeding to newer ones. - Staged Rollout: Managed through the
limitandpercentage_limitflags, staged rollouts enable gradual deployment of updates to a subset of users, allowing for monitoring and issue resolution before full release.
Note: Incremental Release and Staged Rollout are not supported for templates and widgets.
Request
Path Parameters
Body
The maximum number of downloads allowed for this version. This is used for staged rollout of WordPress products. Unlimited number is set as null.
Responses
- 200
- 400
- 401
- 402
- 404
The updated deployment.
Schema
The Freemius SDK version. Only relevant for WordPress products using the Freemius WP SDK.
The maximum number of downloads allowed for this version. This is used for staged rollout of WordPress products. Unlimited number is set as null.
Bad request. The request could not be understood by the server due to malformed syntax or arguments.
Schema
Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.
Schema
The request is missing the specified argument.
Schema
The requested resource was not found.