SDK method

tools.createOutreachCampaign

Create outreach campaign. Convenience alias for create_outreach_campaign, forwarding to tinbox.api.outreach.create.mutate.

Signature

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

Name	Type	Required	Description
`name`	string	yes	Internal campaign name, e.g. 'YC W26 founders'.
`brief`	string	no	The ICP / goal prompt that drives sourcing + drafting.
`sendingDomainId`	string	no	The COLD sending domain id (validated: must exist + have a cold transport; an unverified subdomain is allowed but warned).
`fromName`	string	no	Sender name on the cold subdomain.
`fromEmail`	string	no	Sender email (must resolve to the cold subdomain).
`replyTo`	string	no	Reply-to (must be a monitored mailbox so replies thread to the Inbox).
`rampProfile`	"conservative" \| "standard" \| "assertive"	no	The warmup policy (AUG-C3). 'conservative' for a brand-new domain (warm slowly, low cap), 'standard' the balanced default (~2-week ramp), 'assertive' for a warm domain with reputation. Owns the daily-cap + ramp numbers — prefer this over raw dailyCap.
`dailyCap`	number	no	Advanced: raw daily send cap (cold-volume guard). Prefer rampProfile; a raw value overrides the profile's cap.
`sourcingConfig`	object	no	Stored sourcing strategy; source_prospects later runs it without re-specifying.

ReturnType<TinboxTools["createOutreachCampaign"]>

await tinbox.tools.createOutreachCampaign({
  "name": "<name>"
});