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.
Authorizations
Path Parameters
Identifier of the benefit.
Body
- BenefitCustomUpdate
- BenefitDiscordUpdate
- BenefitGitHubRepositoryUpdate
- BenefitDownloadablesUpdate
- BenefitLicenseKeysUpdate
- BenefitMeterCreditUpdate
- BenefitFeatureFlagUpdate
"custom"Metadata map for information your integration needs to retain.
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.
Description attached to the benefit. Will be displayed on products having this benefit.
3 - 42Visibility: Controls whether customers can see this benefit in their portal.
draft, private, public Properties for a benefit of type custom.
Response
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.
Unique identifier for the benefit.
The time Ruba created this record.
The time this record last changed.
"custom"Description attached to the benefit.
Indicates whether the benefit is selectable when creating a product.
Indicates whether the benefit is deletable.
Indicates whether the benefit is deleted.
Unique identifier for the organization owning the benefit.
Visibility: Controls whether customers can see this benefit in their portal.
draft, private, public Properties for a benefit of type custom.