Update a Subscription

Updates an existing subscription. Follow conventional PATCH behavior, so only included fields will be updated.

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

subscriptionID*string

ID of the subscription to update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Name of subscription.

type?string

Type of subscription.

Value in

"transform" | "analyze" | "route" | "join" | "split_collection" | "split_item" | "evaluation" | "error" | "payload_shaping" | "enrich" | "collection_processing"

disabled?boolean

Toggles whether subscription is active or not.

functionName?string

Unique name of function this subscription listens to.

webhookURL?string

URL bem will send webhook requests to.

s3Bucket?string

S3 bucket name for syncing output data to AWS S3.

s3FilePath?string

S3 file path for syncing output data to AWS S3.

googleDriveFolderID?string

Google Drive folder ID for syncing output data to Google Drive.

Response Body

`application/json`

curl -X PATCH "https://api.bem.ai/v1-alpha/subscriptions/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "name": "string",
  "subscriptionID": "string",
  "type": "transform",
  "functionID": "string",
  "functionName": "string",
  "collectionID": "string",
  "collectionName": "string",
  "disabled": true,
  "webhookURL": "string",
  "s3Bucket": "string",
  "s3FilePath": "string",
  "googleDriveFolderID": "string"
}