Skip to main content
PUT
Update a notification settings

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

settingsId
string
required

Settings ID

Body

application/json
eventType
enum<string>
Available options:
workflow_started,
workflow_finished,
workflow_failed,
workflow_sample_finished,
workflow_data_change,
system_maintenance,
service_degradation,
credits_low,
free_trial_ending
eventConfiguration
object

Settings specific to the event type. Currently accepts an empty object {}. This object will be extended in future releases to support event-specific configuration options.

enabled
boolean
channelIds
string[]

Array of channel IDs to link to this settings

Response

Settings updated successfully

data
object
status
string
message
string