Skip to main content
Update a subscription

Authorizations

Authorization
string
header
required

An API key from Settings, API keys, with the feeds scope.

Path Parameters

subscriptionId
string
required

Body

application/json
name
string
Maximum string length: 120
places
string[]

Place ids. Every dataset in each place.

topics
string[]

Only these topics within places. Every topic when left out.

datasetIds
string[]

Datasets to include on their own, in any covered place.

delivery
Pull · object

Where a subscription's files are delivered. More destination types are added as customers need them; each receives the same files.

format
enum<string>
default:geoparquet

The format pushed deliveries are written in.

Available options:
geoparquet,
csv

Response

200 - application/json

The updated subscription.

id
string
required
name
string
required
places
string[]
required
topics
string[]
required
datasetIds
string[]
required
delivery
Pull · object
required

Where a subscription's files are delivered. More destination types are added as customers need them; each receives the same files.

datasetCount
integer
required
createdAt
string<date-time>
required
format
enum<string>
Available options:
geoparquet,
csv
lastEventId
string | null