Skip to content

SDK method

tools.draftOutreachBody

Draft one outreach body. Convenience alias for draft_outreach_body, forwarding to tinbox.api.outreach.draftProspect.mutate.

Signature

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

Parameters

NameTypeRequiredDescription
campaignIdstringyesThe outreach campaign id.
prospectIdstringyesThe prospect id (from list_review_queue).
instructionstringnoOverride the base instruction (else the campaign's first sequence step).

Returns

ReturnType<TinboxTools["draftOutreachBody"]>

Example

ts
await tinbox.tools.draftOutreachBody({
  "campaignId": "<campaignId>",
  "prospectId": "<prospectId>"
});