Drafts API

Drafts API

Unsaved work held server-side per resource type, so a half-written agent or campaign survives a closed tab. Save, load and discard.

On this page

Endpoints
Authentication
Objects returned

Endpoints#

4 operations, each with its parameters, schemas and an example request on its own page.

getList drafts/api/draftsEverything this person has left unsaved.
putSave draft/api/draftsSaves this person's in-progress edit.
getLoad draft/api/drafts/{resource_type}Restores a draft, and says whether it is safe to apply.
deleteDiscard draft/api/drafts/{resource_type}Throws a draft away - called when the real save succeeds.

Authentication#

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned#

The models these endpoints send back, with every field. Open one to read it.

Message2 fields

messagestringrequired
okboolean
Default: true

Something unclear or missing? Tell us and we’ll fix it.