Campaign setup

Create the campaign in Scribeless before sending recipients through the API. Recipient creation needs a campaign destination.

You can create that campaign in the platform UI, which is usually the simplest option. If you already have the required product and template IDs, you can also create one with POST /api/campaigns.

Find the campaign ID

The campaignId field in POST /api/recipients tells Scribeless which campaign should receive the recipient data.

{
  "campaignId": "CAMPAIGN_ID",
  "data": {
    "firstName": "Ada",
    "lastName": "Lovelace"
  }
}

Use the ID for the campaign whose creative, product, delivery settings, template variables, and testing status you want to use.

Template variables

Set up the campaign template before sending API recipients. Any personalization fields used by the campaign must be present in each recipient payload.

Use variables for custom values:

{
  "variables": {
    "custom1": "This is a personalized first sentence",
    "custom2": "www.scribeless.co"
  }
}

If your campaign was built around named custom fields, keep those names consistent between the campaign and API payload.

Pending and testing mode

New recipients are added to the campaign with a pending status before rendering and downstream processing.

If the campaign is in testing mode, recipients created against it are testing recipients. Testing recipients are useful for validation and should not be treated as live mail. In the application UI, testing recipients are marked as not sent.

Billing notes

Live recipient creation may create billable usage according to the campaign product, delivery settings, and account pricing. Test with one non-sensitive recipient before enabling an automation, and confirm your campaign is no longer in testing mode before sending live recipients.

Approved partner invoice-billed workflows may require an explicit checkout step before recipients move toward fulfilment. See POST /api/recipients/checkout.

For campaign and recipient status definitions, see the Campaign and recipient statuses Help Center article.