- API Overview
- API Rate Limiting
Events
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Environments
Changes
Execution Details
Feeds
Tenants
Organizations
Messages
API Reference
Workflow Overrides
Create workflow overrides
POST
/
v1
/
workflow-overrides
Authorization
string
*
Authorization
Required
string
object
*
workflowId
string
*
workflowId
Required
string
tenantId
string
*
tenantId
Required
string
active
boolean
active
boolean
preferenceSettings
object
preferenceSettings
object
email
boolean
email
boolean
sms
boolean
sms
boolean
in_app
boolean
in_app
boolean
chat
boolean
chat
boolean
push
boolean
push
boolean
curl --request POST \
--url https://api.novu.co/v1/workflow-overrides \
--header 'Content-Type: application/json' \
--data '{
"workflowId": "<string>",
"tenantId": "<string>",
"active": true,
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
}
}'
{
"data": {
"_id": "<string>",
"_organizationId": "<string>",
"_environmentId": "<string>",
"_workflowId": "<string>",
"_tenantId": "<string>",
"active": true,
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
},
"deleted": true,
"deletedAt": "<string>",
"deletedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Body
application/json
workflowId
string
requiredtenantId
string
requiredactive
boolean
preferenceSettings
object
preferenceSettings.email
boolean
preferenceSettings.sms
boolean
preferenceSettings.in_app
boolean
preferenceSettings.chat
boolean
preferenceSettings.push
boolean
Response
200 - application/json
data
object
data._id
string
requireddata._organizationId
string
requireddata._environmentId
string
requireddata._workflowId
string
requireddata._tenantId
string
requireddata.active
boolean
requireddata.preferenceSettings
object
requireddata.preferenceSettings.email
boolean
data.preferenceSettings.sms
boolean
data.preferenceSettings.in_app
boolean
data.preferenceSettings.chat
boolean
data.preferenceSettings.push
boolean
data.deleted
boolean
requireddata.deletedAt
string
data.deletedBy
string
data.createdAt
string
requireddata.updatedAt
string
requiredWas this page helpful?
curl --request POST \
--url https://api.novu.co/v1/workflow-overrides \
--header 'Content-Type: application/json' \
--data '{
"workflowId": "<string>",
"tenantId": "<string>",
"active": true,
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
}
}'
{
"data": {
"_id": "<string>",
"_organizationId": "<string>",
"_environmentId": "<string>",
"_workflowId": "<string>",
"_tenantId": "<string>",
"active": true,
"preferenceSettings": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
},
"deleted": true,
"deletedAt": "<string>",
"deletedBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}