Skip to content

SDK method

tools.getOutreachCampaign

Get outreach campaign. Convenience alias for get_outreach_campaign, forwarding to tinbox.api.outreach.get.query.

Signature

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

Parameters

NameTypeRequiredDescription
idstringyesThe outreach campaign id.

Returns

ReturnType<TinboxTools["getOutreachCampaign"]>

Example

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