Skip to content
Docs
Open Escouade
Documentation contents

Docs › Mail › Tools

preview_campaign

View as .md

Review a campaign before sending.

Checks the recipients, the blocks, the duplicates and every field of each variant. Returns a personalised preview of each step and variant, along with the errors. Sends nothing.

Access

  • Key: an Escouade Mail key with read.
  • Space: any space, verified or not.
  • Changes nothing: yes, it only reads.
  • Safe to replay: yes.

Parameters

ParameterTypeRequiredDescription
campaign_idstringyesCampaign.
offsetintegernoPosition to start from among the recipients, for the next page.

Call it

Terminal
curl -s https://api.subagent.fr/v1/preview_campaign \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sak_…' \
  -d '{"campaign_id": "…"}'

The full page in French, with the response fields and every refusal the tool can return: /mail/docs/reference/preview_campaign.