Update a Product

put

https://api.revenium.ai/profitstream/v2/api/products/{id}

Replaces a product's settings with what you send. Send the whole product, starting from what GET returns and changing what you need. GET returns team, owner and sources as nested objects, but PUT reads only teamId, ownerId and sourceIds, so copy each nested id into those fields; sending GET's sources unchanged removes every data source. teamId, ownerId, name and version are required. Leaving a field out does not always keep its stored value: name, description and plan are kept, but sourceIds, tags, pricingDescription, displayPriority, audienceRestriction, terms and notificationAddressesOnInvoice are cleared. The product is saved with the version you send. For a product published to an API gateway, sending the current version unchanged raises the major number by one, for example 1.0.0 becomes 2.0.0.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

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

Body Params

The full product. Fields you leave out may be cleared, so include every field you want to keep.

A Product

team

teamId

string | null

required

The unique identifier of the team that owns this product

owner

ownerId

string | null

required

The unique identifier of the product owner

sourceConfiguration

sourceConfigurationId

string | null

The source configuration ID

sourceIds

array of strings | null

The source IDs associated with the product

sourceIds

environment

environmentId

string | null

The environment id

name

string

required

The name of the product

version

string

required

The product version, in MAJOR.MINOR.PATCH form such as 1.0.0. Required on create and update. On update the product is saved with the version you send, so send a new value to change it or the current value to keep it. One exception: for a product published to an API gateway, sending the current version unchanged raises the major number by one, for example 1.0.0 becomes 2.0.0.

externalLabel

string | null

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

plan

required

portalLabel

string | null

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

externalId

string | null

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

portalId

string | null

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

description

string | null

The description of the product

descriptionAsHTML

string | null

The description of the product (HTML formatted)

shortDescription

string | null

A short description of the product

shortDescriptionAsHTML

string | null

The short description of the product (HTML formatted)

published

boolean | null

Whether or not the product is published to a developer portal

preview

boolean | null

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

audienceRestriction

string | null

enum

The audience restriction, if any, on a product

Allowed:

code

string | null

The product code

notifyClientOnInvoice

boolean | null

Whether the subscriber is emailed when an invoice is generated for this product

notificationAddressesOnInvoice

array of strings | null

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

notificationAddressesOnInvoice

logoByteArray

string | null

The product's logo as a byte array

apimGroupId

string | null

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

pricingDescription

string | null

The pricing description

pricingDescriptionAsHTML

string | null

The pricing description (HTML formatted)

tags

terms

array of objects | null

Terms and conditions associated with this product.

terms

invoiceManagement

paymentSource

string | null

enum

The product payment source

Allowed:

comingSoon

boolean

Whether to display the coming soon ribbon

comingSoonText

string | null

The text to display in the coming soon ribbon

meteringModels

array of strings | null

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

meteringModels

Allowed:

notifyClientTrialAboutToExpire

boolean | null

Whether the subscriber is emailed when their trial is about to expire

paymentConfigurationId

string | null

The payment configuration ID associated with the product

tierQuotaNotificationThreshold

double | null

The default quota notification threshold for new subscriptions to this product, as a fraction from 0 to 1. For example 0.8 means a notification is sent once 80% of a tier quota is used. 0 means no notification. A subscription created without its own tierQuotaNotificationThreshold copies this value.

displayPriority

double | null

The displayPriority of the product

apimConfigurationId

string | null

The Anypoint configuration ID associated with the product

performanceDefinition

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Product updated successfully

400Invalid request

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Product not found

409Conflict

422Unprocessable entity - Validation failed

429Too Many Requests

500Internal server error

504Gateway Timeout