Whiteboards are the Engage tool for designing and automating marketing campaigns as visual, multi-step customer journeys — always-on programs that respond to contact behavior and attributes across channels. This use case shows how to build a Whiteboard and activate it through the Engage API, so you can create and deploy these automations programmatically instead of in the UI.
Prerequisites
Before you begin, make sure you have valid authorization credentials. See Getting Started with Engage API for more information. A Whiteboard is first saved as a draft and then published.
Procedure
Optionally, list the available templates with GET /whiteboard/listTemplates to start from a template. Save the Whiteboard; the request body is a wrapper whose json field carries the diagram document as an escaped string.
POST 'https://your-engage-domain.com/api/rest/whiteboard/save'
{
"json": "<escaped diagram JSON>"
}The response returns the whiteboard's id. You can check the diagram with POST /whiteboard/validate. Publish it to make it live:
POST 'https://your-engage-domain.com/api/rest/whiteboard/publish'
{
"automationId": <whiteboardId>,
"diagramJson": "<escaped diagram JSON>"
}Conclusion
save returns the whiteboard id; publish activates it and rejects an invalid diagram with a 400 response.