Update a Data Feeds subscription

Replace the fields sent and keep the rest. Send the revision read, as revision or, over REST, the If-Match header; a stale one is refused as precondition_failed, so two edits never overwrite each other. Datasets that join send feed.dataset.added, those that leave feed.dataset.removed.

patch/v1/subscriptions/{subscriptionId}

Request

  • Base URL: https://api.ploti.ai
  • URL: https://api.ploti.ai/v1/subscriptions/{subscriptionId}
  • Auth: HTTP bearer

Path parameters

subscriptionIdstring required

The subscription, by the id create_feed_subscription gave.

Headers

If-Matchstring

The ETag the resource was read with. A stale one is refused as precondition_failed.

Request body

revisioninteger

The revision the subscription was read at; over REST it may come as the If-Match header instead.

namestring
placesstring[]

Place ids from list_feed_places. Every deliverable dataset in each place.

topicsstring[]

Only these topics within places, by the ids list_feed_topics gives. Every topic when left out.

datasetIdsstring[]

Datasets to include on their own, from any place in the coverage.

Response

Done

idstring required
namestring required
placesstring[] required
topicsstring[] required
datasetIdsstring[] required
revisioninteger required

Send it back as If-Match (or revision) to update.

datasetCountinteger required
lastEventCursorstring nullable required
createdAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.