Skip to main content

Create a notification workflow

POST 
/api/v1/notifications/manage/create-workflow

Creates a new notification workflow definition with steps, channel configuration, and preference settings.

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 created

Create the in-app welcome definition from the administration recipe; provider JSON is passed through.​

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

Request example

{
  "workflow": {
    "name": "Welcome Notification",
    "description": "Sent when a user completes onboarding",
    "__source": "editor",
    "steps": [
      {
        "name": "In-App Step",
        "type": "in_app",
        "controlValues": {
          "body": "Welcome to your health coaching journey!"
        }
      }
    ]
  }
}

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

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

Response example

{
  "workflow": {
    "example": "value"
  }
}

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

SectionStable reference
Create a notification workflowDOC-CP-notifications-api-createWorkflow#overview
RequestDOC-CP-notifications-api-createWorkflow#request
ResponsesDOC-CP-notifications-api-createWorkflow#responses