SDK method
tools.sendTestCampaign
Send test campaign. Convenience alias for send_test_campaign, forwarding to tinbox.api.campaigns.sendTest.mutate.
Signature
ts
sendTestCampaign(input: Parameters<TinboxTools["sendTestCampaign"]>[0]): ReturnType<TinboxTools["sendTestCampaign"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | The campaign id. |
to | string | yes | The email address to send the test to. |
Returns
ReturnType<TinboxTools["sendTestCampaign"]>
Example
ts
await tinbox.tools.sendTestCampaign({
"id": "<id>",
"to": "ada@example.com"
});