Skip to content

SDK method

tools.updateDraft

Edit a draft. Convenience alias for update_draft, forwarding to tinbox.api.drafts.update.mutate.

Signature

ts
updateDraft(input: Parameters<TinboxTools["updateDraft"]>[0]): ReturnType<TinboxTools["updateDraft"]>

Parameters

NameTypeRequiredDescription
idstringyesThe draft id.
baseVersionnumbernoThe version you read before editing.
subjectstringno—
bodyTextstringno—

Returns

ReturnType<TinboxTools["updateDraft"]>

Example

ts
await tinbox.tools.updateDraft({
  "id": "<id>"
});