Skip to main content

Test email

Api call to subrite to test email

  • Method: POST
  • Route: {baseUrl}/api/v1/communications/email/test
  • Authorization: Bearer token (use the m2m token collected in ## configuration)
  • Body: See example below

Example of body :​

{
  "communicationType": "marketing",  // Possible values: "marketing" or "information"
  "name": "coming from external",
  "senderId": 2,  // Use sender ID from Step 2 response
  "consentId": null,
  "segmentId": 1,  // Use segment ID from Step 3 response
  "subject": "email subject",
  "emailPreviewText": "sample",
  "templateId": 1, // Optional
  "emailContent": "<div>hello world</div>",
  "recipients": ["[email protected]", "[email protected]"], // Always use an array for recipients, even when sending to a single address. Maximum 5 recipients allowed per test email.
  "hostName": "example.com" // Optional. See "Host name" below.
}

Host name​

hostName is optional. When set, unsubscribe links generated for this email use the supplied hostname instead of the tenant's primary hostname. Use it when your tenant serves multiple brand domains so recipients land on the correct brand.

  • Must match the tenant's primary hostname or one of its registered additional hostnames. Foreign or unregistered hostnames are silently ignored and the tenant's primary hostname is used as a fallback.
  • DNS-safe characters only (a–z, 0–9, ., -, optional :port); IDN hostnames must be supplied in punycode form.
  • Omit the field to use the tenant's primary hostname.

Success API Response :​

{
  success: true,
  message: 'Test emails sent successfully',
  id: 12212
}