Skip to content

SDK method

tools.getCampaign

Get campaign details. Convenience alias for get_campaign, forwarding to tinbox.api.campaigns.get.query.

Signature

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

Parameters

NameTypeRequiredDescription
idstringyesThe campaign id.

Returns

ReturnType<TinboxTools["getCampaign"]>

Example

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