Skip to main content
PATCH
Change one buy box

Authorizations

Authorization
string
header
required

Authorization code with PKCE. The person grants the scopes on the Investorlift consent page and accepts the Marketplace API Terms there.

Path Parameters

buy_box_id
string
required

The public id in the path, for example buy_box_id as mdl_a1b2c3d4e5f6.

Body

application/json
name
string
Required string length: 2 - 120
geo_feature_ids
string[]
Required array length: 1 - 25 elements
Minimum string length: 1
criteria
object
is_default
boolean

Send true to make this box the default. A buyer always keeps one default.

alerts
object

The alert switch of the box. A body with no alerts member keeps the switch.

Response

Success

data
object
required
meta
object
required