SDK method

tools.personalizeCampaign

Personalize campaign. Convenience alias for personalize_campaign, forwarding to tinbox.api.campaigns.personalize.mutate.

Signature

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

Parameters

Name	Type	Required	Description
`id`	string	yes	The campaign id.
`instruction`	string	yes	The base instruction the per-recipient bodies are written against.
`recipients`	object[]	yes	The subscribers to personalize for, each with their usage stats.

Returns

ReturnType<TinboxTools["personalizeCampaign"]>

Example

await tinbox.tools.personalizeCampaign({
  "id": "<id>",
  "instruction": "<instruction>",
  "recipients": [
    {
      "recipient": "<recipient>",
      "stats": {}
    }
  ]
});