Change Benefit
Intent
Applies the supplied changes to the benefit.
When to call it
Call this when the benefit already exists and its stored values need to change.
Access boundary
Authorize the request with a token that carries benefits:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Operational notes
Update a benefit.
Scopes: benefits:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The benefit ID.
Body
- BenefitCustomUpdate
- BenefitDiscordUpdate
- BenefitGitHubRepositoryUpdate
- BenefitDownloadablesUpdate
- BenefitLicenseKeysUpdate
- BenefitMeterCreditUpdate
- BenefitFeatureFlagUpdate
"custom"Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
The description of the benefit. Will be displayed on products having this benefit.
3 - 42The visibility of the benefit in the customer portal.
draft, private, public Properties for a benefit of type custom.
Response
Benefit updated.
- BenefitCustom
- BenefitDiscord
- BenefitGitHubRepository
- BenefitDownloadables
- BenefitLicenseKeys
- BenefitMeterCredit
- BenefitFeatureFlag
A benefit of type custom.
Use it to grant any kind of benefit that doesn't fit in the other types.
The ID of the benefit.
The time Ruba created this record.
The time this record last changed.
"custom"The description of the benefit.
Whether the benefit is selectable when creating a product.
Whether the benefit is deletable.
Whether the benefit is deleted.
The ID of the organization owning the benefit.
The visibility of the benefit in the customer portal.
draft, private, public Properties for a benefit of type custom.