Sign in

v1

latestSwagger 2.02026-07-172161122.5 KB
Outreach

Generate email tracking URLs

Generates tracking pixels, click tracking URLs, and unsubscribe links for email campaigns

post/outreach/v1/email/tracking

Request body

campaignIdstring

Unique identifier for the email campaign required: true example: camp_123456

generateUnsubscribeLinkboolean

Enable unsubscribe link generation required: false default: false

linksstring[]

List of URLs to be tracked required: false example: ["https://example.com/page1", "https://example.com/page2"]

messageIdstring

Unique identifier for the message (optional, generated if not provided) required: false example: msg_123456

recipientIdstring

Unique identifier for the recipient required: true example: recipient_123456

trackClicksboolean

Enable click tracking for links required: false default: false

trackOpensboolean

Enable open tracking via pixel required: false default: false

trackerDomainstring

Domain to use for tracking URLs (optional, system default used if not provided) required: false format: hostname example: track.example.com

unsubscribeLinkstring

URL for unsubscribe page required: false format: uri example: https://example.com/unsubscribe

Response

Tracking URLs generated successfully

statusstring

Operation status required: true enum: success

trackingIdstring

Generated or provided message ID required: true

trackingPixelstring

URL for tracking pixel (only if TrackOpens is true) required: false format: uri

unsubscribeLinkstring

Generated unsubscribe link (only if GenerateUnsubscribeLink is true) required: false format: uri

Example response

{
  "status": "success",
  "trackedLinks": [
    {
      "original": "https://example.com/page1",
      "tracked": "https://track.example.com/r/abc123"
    }
  ],
  "trackingId": "msg_123456",
  "trackingPixel": "https://track.example.com/p/abc123",
  "unsubscribeLink": "https://track.example.com/u/abc123"
}