Update an existing notification workflow

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

Updates the identified workflow using the supplied definition.

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

200

Workflow updated

Replace an existing workflow with the complete definition; preserve every delivery step you intend to keep.

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

Request example

{
  "workflowId": "welcome-notification",
  "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-updateWorkflow#example-notifications-updateWorkflow-response

Response example

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

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

Section	Stable reference
Update an existing notification workflow	DOC-CP-notifications-api-updateWorkflow#overview
Request	DOC-CP-notifications-api-updateWorkflow#request
Responses	DOC-CP-notifications-api-updateWorkflow#responses