Skip to main content

Delete a notification workflow

POST 

/api/v1/notifications/manage/delete-workflow

Deletes a notification workflow. The workflow can be identified by either workflow ID or trigger identifier.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Welcome a new user with an in-app message

Request​

Responses​

Workflow deleted

Retire an existing workflow after stopping new triggers.​

Section ID: DOC-CP-notifications-api-deleteWorkflow#example-notifications-deleteWorkflow-request

Request example

{
"workflowId": "welcome-notification"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-deleteWorkflow#example-notifications-deleteWorkflow-response

Response example

{
"workflowId": "example_123"
}

Document ID: DOC-CP-notifications-api-deleteWorkflow. Section identities and revisions.

SectionStable reference
Delete a notification workflowDOC-CP-notifications-api-deleteWorkflow#overview
RequestDOC-CP-notifications-api-deleteWorkflow#request
ResponsesDOC-CP-notifications-api-deleteWorkflow#responses