API Reference
Log In
API Reference

Update a Product

put
https://api.revenium.ai/profitstream/v2/api/products/

Update a product by id. The version field will be automatically incremented by the API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the product to update. Format: Revenium hashid (URL-safe encoded string).

Body Params

Updated product configuration. Only include fields you want to change.

string
required

The unique identifier of the team that owns this product

string
required

The unique identifier of the product owner

string

The source configuration ID

sourceIds
array of strings

The source IDs associated with the product

sourceIds
string

The environment id

string
required

The name of the product

string
required

The version of the product following semantic versioning (MAJOR.MINOR.PATCH). When creating a product, specify the initial version (e.g., '1.0.0'). When updating a product, the API automatically increments the version based on internal versioning rules. You can specify a version in the update request, but the API may override it

string

An external label for the product that is exposed in developer portals

plan
object
required

The plan of the product

string

An external label for the product that is exposed in developer portals

string

An external identifier (ie, in a api management system) that is associated with the Product

string

An external id for the product that is exposed in developer portals

string

The description of the product

string

The description of the product (HTML formatted)

string

A short description of the product

string

The short description of the product (HTML formatted)

boolean

Whether or not the product is published to a developer portal

boolean

Whether or not the product is in preview mode in a developer portal

string

The audience restriction, if any, on a product

string

The product code

boolean

Notify client when an invoice is generated for this product

notificationAddressesOnInvoice
array of strings

A list of email addresses to notify when an invoice is generated for this product

notificationAddressesOnInvoice
string

The product's logo as a byte array

string

An external API group identifier (ie, in a API management system) that is associated with the Product

string

The pricing description

string

The pricing description (HTML formatted)

tags
array of strings

A list of tags associated with this product. Optional field - can be omitted entirely, provided as empty array [], or contain tag values

tags
terms
array of objects

Terms and conditions associated with this product.

terms
invoiceManagement
object

The invoice management configuration for the product

string

The product payment source

boolean
required

Whether to display the coming soon ribbon

string

The text to display in the coming soon ribbon

meteringModels
array of strings

The metering models associated with the product. Optional field - can be omitted entirely, provided as empty array [], or contain model values

meteringModels
boolean

Whether to notify the client when the trial is about to expire

string

The payment configuration ID associated with the product

double

The threshold Percentage for tier quota notifications

double

The displayPriority of the product

string

The Anypoint configuration ID associated with the product

performanceDefinition
object

The APIM Performance Definition (SLA)

Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago