Market routes: update, delete

Reference for Market, one group of Market routes.

Market.update

Changes the given properties of a Market. Verb page.

Text

PATCH /{namespace}/markets/{id}

Path: id. Body, as JSON: the other inputs. Emits Market.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Market.
`countries`	`string[]`		ISO 3166-1 alpha-2 country codes.
`currency`	`string`		The ISO 4217 currency Prices show in.
`locales`	`string[]`		BCP 47 locale tags, the default first.

Returns

Output	Type	Required	Description
`market`	Market	required	The Market.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/markets/market_4uFEzN14G4 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"currency":"USD"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "market": {
    "$id": "https://api.sb/leaseline.app/markets/market_4uFEzN14G4",
    "$type": "Market",
    "countries": [
      "Example countries"
    ],
    "currency": "USD",
    "locales": [
      "Example locales"
    ]
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Market.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Market.delete

Deletes a Market: a soft delete that keeps its history, undone by Thing.restore. Verb page.