Upsert ecommerce settings

Last updated March 26, 2019

PUT /extensions/ecomm/v2/settings

This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

Method Details

HTTP Methods:


Content Type:


Response Format:


Requires Authentication?


Rate Limited?





Developer Tools

Required Scope:


Create or update the ecommerce settings.

Note: If you are working with an installed app using OAuth, you must use your developer hapikey and your app ID to use this endpoint. The settings are applied to the app, and would affect any portals that have your app installed.
Required Parameters How to use Description
API key hapikey=
Used in the request URL
The API key (hapikey) for your portal or your app.
Note: If you are working with an installed app using OAuth, you must use the Developer HAPIkey associated with the Developer portal that the OAuth app was created in.
App ID &appId=
Used in the request URL
The ID of the app, created inside your HubSpot Developer portal. Required if you are updating the settings for an installed app.

Optional Parameters How to use Description
Show Provided Mappings showProvidedMappings= Boolean to indicate if the response should contain the HubSpot defined mappings. Defaults to false
App Settings JSON Used in the request body. Any properties that you want to set for ecommerce. Please see the Ecommerce Bridge Overview for more details on the available settings. Note that any mappings not included in the request that have been previously defined will be removed.