Checklists
Create a checklist
Creates the checklist as a draft. Pass active: true to publish immediately — the checklist must have at least one item and targeting set, otherwise it stays a draft and the response note explains why. The response includes a dashboardUrl for reviewing the checklist in the builder.
Authorization
BearerAuth AuthorizationBearer <token>
Use an API key from the Produktly dashboard → Settings → API keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/checklists" \ -H "Content-Type: application/json" \ -d '{ "name": "Getting started", "items": [ { "title": "Invite a teammate", "content": "Add at least one collaborator.", "type": "custom", "completionType": "page-event", "pageEventElementSelector": "[data-checklist=\'invite\']" }, { "title": "Create your first project", "type": "open-url", "redirectToUrl": "/projects/new", "completionType": "manual-click" } ], "targeting": { "showOnAllPages": true }, "active": true }'{ "id": 0, "name": "string", "active": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "folderId": 0, "themeId": 0, "items": [ { "property1": null, "property2": null } ], "settings": { "property1": null, "property2": null }, "rules": [ { "property1": null, "property2": null } ], "ruleLogicalOperator": "string", "dashboardUrl": "string", "note": "string"}