Skip to content

SDK method

tools.getSendReadiness

Check send readiness. Convenience alias for get_send_readiness, forwarding to tinbox.api.readiness.status.query.

Signature

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

Parameters

NameTypeRequiredDescription
lane"broadcast" | "outreach" | "journey"yesWhich send lane: broadcast (newsletter), outreach (cold 1:1-at-bulk), or journey (automation).
phase"create" | "send"no'create' (permissive — empty audience is a warning) or 'send' (strict — empty audience blocks). Default: create.

Returns

ReturnType<TinboxTools["getSendReadiness"]>

Example

ts
await tinbox.tools.getSendReadiness({
  "lane": "broadcast"
});