{"items":[{"type":"link","label":"MailerLogic API","link":"/customer-api.openapi","routeSlug":"/customer-api.openapi","content":{"contentType":"overview","meta":{"name":"MailerLogic API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"customer-api.openapi.json","url":"/_bundle/customer-api.openapi.json?download"},{"kind":"download","label":"customer-api.openapi.yaml","url":"/_bundle/customer-api.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://support.mailerlogic.com","url":"https://support.mailerlogic.com"},{"kind":"email","title":"Support","email":"support@mailerlogic.com","label":"support@mailerlogic.com","withCopyButton":true,"copyContent":"support@mailerlogic.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"MailerLogic API (1.4.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete REST API for managing email delivery, tracking, and analytics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get started in minutes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send authenticated requests using the X-API-Key header"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start sending emails via SMTP or API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For detailed guides, see the Getting Started section in the navigation."},"children":[]}]}]}]}],"sectionId":"/customer-api.openapi"}],"sectionId":"/customer-api.openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/response-conventions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Conventions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New and updated endpoints use these shapes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List endpoints: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"data\": [ ... ], \"pagination\": { ... } }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single-resource endpoints: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"data\": { ... } }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"error\": \"Human-readable message\", \"code\": \"ERROR_CODE\", \"details\": {}, \"request_id\": \"...\" }"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some older endpoints also return legacy fields such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhooks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for backward compatibility. Prefer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in new integrations when both are present."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every API response includes an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Request-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Include this value when contacting support."},"children":[]}]}]}]}],"sectionId":"/customer-api.openapi/section/response-conventions"}]}]}},{"type":"link","label":"Response Conventions","link":"/customer-api.openapi/section/response-conventions","routeSlug":"/customer-api.openapi/section/response-conventions","content":null},{"type":"separator","label":"Getting Started","content":null},{"type":"group","label":"Quickstart Guide","link":"/customer-api.openapi/quickstart-guide","routeSlug":"/customer-api.openapi/quickstart-guide","items":[{"type":"link","label":"Prerequisites","link":"/customer-api.openapi/quickstart-guide/prerequisites","routeSlug":"/customer-api.openapi/quickstart-guide/prerequisites","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Prerequisites"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/prerequisites"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prerequisites"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active MailerLogic account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key (available in your customer dashboard)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A verified sending domain (or use the verification process below)"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Step 1: Get Your API Key","link":"/customer-api.openapi/quickstart-guide/step-1:-get-your-api-key","routeSlug":"/customer-api.openapi/quickstart-guide/step-1:-get-your-api-key","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Step 1: Get Your API Key"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/step-1:-get-your-api-key"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1: Get Your API Key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your API key is available in your customer dashboard. It will look like this:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"ml_live_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ml_live_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep this key secure!"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Never commit it to version control or share it publicly."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Step 2: Set Up Your Domain","link":"/customer-api.openapi/quickstart-guide/step-2:-set-up-your-domain","routeSlug":"/customer-api.openapi/quickstart-guide/step-2:-set-up-your-domain","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Step 2: Set Up Your Domain"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/step-2:-set-up-your-domain"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2: Set Up Your Domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add your domain via the API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/domains \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"domain\": \"mail.yourdomain.com\"}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/domains \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"domain\": \"mail.yourdomain.com\"}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get DNS records to add:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl https://api.mailerlogic.net/api/v1/customer/domains/{DOMAIN_ID}/dns \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl https://api.mailerlogic.net/api/v1/customer/domains/{DOMAIN_ID}/dns \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add the returned DNS records to your DNS provider, then verify:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/domains/{DOMAIN_ID}/verify \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/domains/{DOMAIN_ID}/verify \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Step 3: Send Your First Email","link":"/customer-api.openapi/quickstart-guide/step-3:-send-your-first-email","routeSlug":"/customer-api.openapi/quickstart-guide/step-3:-send-your-first-email","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Step 3: Send Your First Email"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/step-3:-send-your-first-email"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3: Send Your First Email"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can send emails via "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Option A: Send via REST API (Recommended)","link":"/customer-api.openapi/quickstart-guide/option-a:-send-via-rest-api-(recommended)","routeSlug":"/customer-api.openapi/quickstart-guide/option-a:-send-via-rest-api-(recommended)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Option A: Send via REST API (Recommended)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"quickstart-guide/option-a:-send-via-rest-api-(recommended)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option A: Send via REST API (Recommended)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/send \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"from\": \"hello@mail.yourdomain.com\",\n    \"from_name\": \"MailerLogic Team\",\n    \"to\": \"recipient@example.com\",\n    \"subject\": \"Hello from MailerLogic!\",\n    \"html\": \"<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p><p><a href=\\\"{{unsubscribe}}\\\">Unsubscribe</a></p>\",\n    \"text\": \"Hello! Your first email sent via MailerLogic.\\n\\nUnsubscribe: {{unsubscribe}}\"\n  }'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/send \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"from\": \"hello@mail.yourdomain.com\",\n    \"from_name\": \"MailerLogic Team\",\n    \"to\": \"recipient@example.com\",\n    \"subject\": \"Hello from MailerLogic!\",\n    \"html\": \"<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p><p><a href=\\\"{{unsubscribe}}\\\">Unsubscribe</a></p>\",\n    \"text\": \"Hello! Your first email sent via MailerLogic.\\n\\nUnsubscribe: {{unsubscribe}}\"\n  }'\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Option B: Send via SMTP","link":"/customer-api.openapi/quickstart-guide/option-b:-send-via-smtp","routeSlug":"/customer-api.openapi/quickstart-guide/option-b:-send-via-smtp","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Option B: Send via SMTP"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"quickstart-guide/option-b:-send-via-smtp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option B: Send via SMTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your SMTP credentials:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl https://api.mailerlogic.net/api/v1/smtp-credentials \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl https://api.mailerlogic.net/api/v1/smtp-credentials \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Node.js Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"const nodemailer = require('nodemailer');\n\nconst transporter = nodemailer.createTransport({\n  host: 'smtp.mailerlogic.net',\n  port: 587,\n  auth: {\n    user: 'your-email@example.com',\n    pass: 'smtp_password_here'\n  }\n});\n\nconst mailOptions = {\n  from: 'sender@mail.yourdomain.com',\n  to: 'recipient@example.com',\n  subject: 'Hello from MailerLogic!',\n  html: '<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p><p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>',\n  text: 'Hello! Your first email sent via MailerLogic.\\n\\nUnsubscribe: {{unsubscribe}}'\n};\n\ntransporter.sendMail(mailOptions, (error, info) => {\n  if (error) console.log('Error:', error);\n  else console.log('Email sent:', info.messageId);\n});\n","language":"javascript"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"const nodemailer = require('nodemailer');\n\nconst transporter = nodemailer.createTransport({\n  host: 'smtp.mailerlogic.net',\n  port: 587,\n  auth: {\n    user: 'your-email@example.com',\n    pass: 'smtp_password_here'\n  }\n});\n\nconst mailOptions = {\n  from: 'sender@mail.yourdomain.com',\n  to: 'recipient@example.com',\n  subject: 'Hello from MailerLogic!',\n  html: '<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p><p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>',\n  text: 'Hello! Your first email sent via MailerLogic.\\n\\nUnsubscribe: {{unsubscribe}}'\n};\n\ntransporter.sendMail(mailOptions, (error, info) => {\n  if (error) console.log('Error:', error);\n  else console.log('Email sent:', info.messageId);\n});\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Python Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"import smtplib\nfrom email.mime.text import MIMEText\nfrom email.mime.multipart import MIMEMultipart\n\nmsg = MIMEMultipart('alternative')\nmsg['Subject'] = 'Hello from MailerLogic!'\nmsg['From'] = 'sender@mail.yourdomain.com'\nmsg['To'] = 'recipient@example.com'\n\nhtml = '<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p>'\nmsg.attach(MIMEText(html, 'html'))\n\nwith smtplib.SMTP('smtp.mailerlogic.net', 587) as server:\n    server.starttls()\n    server.login('your-email@example.com', 'smtp_password_here')\n    server.send_message(msg)\n","language":"python"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"import smtplib\nfrom email.mime.text import MIMEText\nfrom email.mime.multipart import MIMEMultipart\n\nmsg = MIMEMultipart('alternative')\nmsg['Subject'] = 'Hello from MailerLogic!'\nmsg['From'] = 'sender@mail.yourdomain.com'\nmsg['To'] = 'recipient@example.com'\n\nhtml = '<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p>'\nmsg.attach(MIMEText(html, 'html'))\n\nwith smtplib.SMTP('smtp.mailerlogic.net', 587) as server:\n    server.starttls()\n    server.login('your-email@example.com', 'smtp_password_here')\n    server.send_message(msg)\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PHP Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"use PHPMailer\\PHPMailer\\PHPMailer;\n\n$mail = new PHPMailer(true);\n$mail->isSMTP();\n$mail->Host = 'smtp.mailerlogic.net';\n$mail->SMTPAuth = true;\n$mail->Username = 'your-email@example.com';\n$mail->Password = 'smtp_password_here';\n$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;\n$mail->Port = 587;\n\n$mail->setFrom('sender@mail.yourdomain.com');\n$mail->addAddress('recipient@example.com');\n$mail->Subject = 'Hello from MailerLogic!';\n$mail->Body = '<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p>';\n$mail->isHTML(true);\n\n$mail->send();\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"use PHPMailer\\PHPMailer\\PHPMailer;\n\n$mail = new PHPMailer(true);\n$mail->isSMTP();\n$mail->Host = 'smtp.mailerlogic.net';\n$mail->SMTPAuth = true;\n$mail->Username = 'your-email@example.com';\n$mail->Password = 'smtp_password_here';\n$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;\n$mail->Port = 587;\n\n$mail->setFrom('sender@mail.yourdomain.com');\n$mail->addAddress('recipient@example.com');\n$mail->Subject = 'Hello from MailerLogic!';\n$mail->Body = '<h1>Hello!</h1><p>Your first email sent via MailerLogic.</p>';\n$mail->isHTML(true);\n\n$mail->send();\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Step 4: Enable Tracking","link":"/customer-api.openapi/quickstart-guide/step-4:-enable-tracking","routeSlug":"/customer-api.openapi/quickstart-guide/step-4:-enable-tracking","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Step 4: Enable Tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/step-4:-enable-tracking"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 4: Enable Tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking is enabled by default on your account. Your emails will automatically include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open tracking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A tiny pixel that tracks when emails are opened"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click tracking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Automatic link wrapping to track clicks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribe links"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One-click unsubscribe per RFC 8058"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding Unsubscribe Links:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your email HTML or text, and it will be automatically replaced with a secure unsubscribe URL:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>\n","language":"html"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This placeholder works in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single emails via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/send"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk emails via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/bulk"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch emails via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/batch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP emails (plain text or HTML)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To disable tracking for specific emails, you can configure it in your account settings."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Step 5: Check Your Statistics","link":"/customer-api.openapi/quickstart-guide/step-5:-check-your-statistics","routeSlug":"/customer-api.openapi/quickstart-guide/step-5:-check-your-statistics","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Step 5: Check Your Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/step-5:-check-your-statistics"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 5: Check Your Statistics"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View your email statistics:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl https://api.mailerlogic.net/api/v1/customer/usage \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl https://api.mailerlogic.net/api/v1/customer/usage \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Next Steps","link":"/customer-api.openapi/quickstart-guide/next-steps","routeSlug":"/customer-api.openapi/quickstart-guide/next-steps","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Next Steps"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/next-steps"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next Steps"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test Your Content"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use our content scoring API before sending campaigns:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/content-score \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"subject\": \"Your Newsletter\", \"html\": \"<html>...</html>\", \"text\": \"...\"}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/content-score \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"subject\": \"Your Newsletter\", \"html\": \"<html>...</html>\", \"text\": \"...\"}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set Up Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Receive real-time notifications for all email events (delivered, opened, clicked, bounced, complained, unsubscribed, failed):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://your-domain.com/webhooks/mailerlogic\",\n    \"events\": [\"email.delivered\", \"email.opened\", \"email.clicked\", \"email.bounced\", \"email.complained\"],\n    \"domain_ids\": null,\n    \"is_active\": true\n  }'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://your-domain.com/webhooks/mailerlogic\",\n    \"events\": [\"email.delivered\", \"email.opened\", \"email.clicked\", \"email.bounced\", \"email.complained\"],\n    \"domain_ids\": null,\n    \"is_active\": true\n  }'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section for domain grouping (multiple domains → one webhook) and complete event documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always use verified domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable tracking for engagement insights"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor your bounce and complaint rates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use suppression lists to avoid known bad addresses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test content before sending large campaigns"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Common Issues","link":"/customer-api.openapi/quickstart-guide/common-issues","routeSlug":"/customer-api.openapi/quickstart-guide/common-issues","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Common Issues"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"quickstart-guide/common-issues"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Domain not verified\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Add all DNS records and wait for propagation (up to 48 hours)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"SMTP authentication failed\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Get fresh credentials from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Rate limit exceeded\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - You've exceeded your daily/monthly quota or throughput limit. Check your limits in the dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Need Help?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Email support@mailerlogic.com or visit https://support.mailerlogic.com"},"children":[]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Quickstart Guide"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quickstart Guide","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get started with MailerLogic in minutes. This guide walks you through sending your first email."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/quickstart-guide"}],"panels":[]}]}},{"type":"group","label":"Features Overview","link":"/customer-api.openapi/features-overview","routeSlug":"/customer-api.openapi/features-overview","items":[{"type":"link","label":"📧 Email Sending","link":"/customer-api.openapi/features-overview/email-sending","routeSlug":"/customer-api.openapi/features-overview/email-sending","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"📧 Email Sending"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/email-sending"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📧 Email Sending"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send individual emails via HTTP with full tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template support with variable substitution"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom headers and metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-domain selection for convenience"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP Integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industry-standard SMTP server (ports 587, 2525)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic connection pooling and retry logic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Works with all major email clients and libraries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum 50 recipients per email, 10MB including attachments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliverability First"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in automated IP warming schedules (2-4 weeks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Smart throttling by recipient domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic bounce and complaint handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time reputation monitoring across all IPs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🌐 Domain Management & Authentication","link":"/customer-api.openapi/features-overview/domain-management-and-authentication","routeSlug":"/customer-api.openapi/features-overview/domain-management-and-authentication","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🌐 Domain Management & Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/domain-management-and-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🌐 Domain Management & Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Easy Domain Setup"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-click domain addition via API or dashboard"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic DKIM key generation (2048-bit RSA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPF and DMARC record recommendations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS verification with detailed status reporting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DKIM signing on all outbound emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPF alignment verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DMARC policy support"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom DKIM selectors available"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-Domain Support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage unlimited verified sending domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-level statistics and reputation tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag-based organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom tracking domains for branded links"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"📊 Advanced Tracking & Analytics","link":"/customer-api.openapi/features-overview/advanced-tracking-and-analytics","routeSlug":"/customer-api.openapi/features-overview/advanced-tracking-and-analytics","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"📊 Advanced Tracking & Analytics"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/advanced-tracking-and-analytics"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📊 Advanced Tracking & Analytics"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open Tracking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time open detection with invisible 1x1 pixel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique vs. total opens tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email client identification (Gmail, Outlook, Apple Mail)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic location by IP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device type and OS detection"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click Tracking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic link wrapping with sub-100ms redirects"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click-through rate analytics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual link performance metrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bot detection and filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Timeline"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comprehensive status tracking: queued → sent → delivered → opened → clicked"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce classification (hard vs. soft)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaint (spam report) tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom event webhooks with retry logic"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-Time Statistics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Live delivery metrics and engagement rates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce and complaint rate monitoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date-range filtering and tag-based segmentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export capabilities with domain-level breakdown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email client distribution and device analytics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🎯 Content Analysis & Scoring","link":"/customer-api.openapi/features-overview/content-analysis-and-scoring","routeSlug":"/customer-api.openapi/features-overview/content-analysis-and-scoring","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🎯 Content Analysis & Scoring"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/content-analysis-and-scoring"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🎯 Content Analysis & Scoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-Send Spam Analysis"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time content scoring before sending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spam trigger detection in subject/HTML/text"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk level assessment (low, medium, high, critical)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actionable improvement suggestions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Categories"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subject line optimization analysis"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTML/text content scanning"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link and image validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header compliance checking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"📋 List Management & Suppressions","link":"/customer-api.openapi/features-overview/list-management-and-suppressions","routeSlug":"/customer-api.openapi/features-overview/list-management-and-suppressions","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"📋 List Management & Suppressions"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/list-management-and-suppressions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📋 List Management & Suppressions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppression Lists"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic bounce-based suppression (hard and soft)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaint-based suppression (spam reports)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual suppression entries via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist management for test accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific unsubscribe tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export suppression lists for compliance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact Organization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (See CRM & Contacts section for details)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag-based organization with unlimited tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom properties for flexible data storage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic segments with real-time filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV bulk import/export capabilities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact status tracking (subscribed, pending_confirmation, unsubscribed, bounced, complained)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🖥️ IP Pool Management","link":"/customer-api.openapi/features-overview/ip-pool-management","routeSlug":"/customer-api.openapi/features-overview/ip-pool-management","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🖥️ IP Pool Management"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/ip-pool-management"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🖥️ IP Pool Management"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dedicated IP Pools"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple IP pool support for segmentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic IP rotation for load balancing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pool-level statistics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic IP assignment options"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP Reputation Monitoring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time reputation tracking per IP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic throttling on reputation issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklist monitoring and alerts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliverability scoring per IP"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated IP Warm-Up"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-configured warm-up schedules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gradual volume increase over 2-4 weeks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily send limit management"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success tracking and adjustments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🔔 Webhooks & Integration","link":"/customer-api.openapi/features-overview/webhooks-and-integration","routeSlug":"/customer-api.openapi/features-overview/webhooks-and-integration","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🔔 Webhooks & Integration"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/webhooks-and-integration"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔔 Webhooks & Integration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound Event Webhooks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time push notifications for email and contact lifecycle events"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email events: sent, delivered, opened, clicked, bounced, complained, unsubscribed, failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact events: created, updated, confirmed, unsubscribed, deleted, tag_added, tag_removed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic retry with exponential backoff (5 attempts)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON payloads with detailed event data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bot/scanner detection included in engagement events"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in customer profile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API-First Design"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESTful architecture with JSON request/response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comprehensive OpenAPI 3.1 specification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interactive documentation with live testing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed error responses with codes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🔐 Security & Compliance","link":"/customer-api.openapi/features-overview/security-and-compliance","routeSlug":"/customer-api.openapi/features-overview/security-and-compliance","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🔐 Security & Compliance"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/security-and-compliance"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔐 Security & Compliance"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication & Access"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key-based authentication with Bearer tokens"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic key rotation capability"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP whitelisting for API access"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intelligent rate limiting (600 API requests/minute, configurable email throughput)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Privacy"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GDPR compliance features and DPA available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configurable data retention policies"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-click unsubscribe (RFC 8058 compliant)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure encrypted data storage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL/TLS Encryption"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All connections encrypted (HTTPS, TLS 1.2+)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STARTTLS for SMTP connections"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic certificate management"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom tracking domain SSL support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🛠️ Developer Tools","link":"/customer-api.openapi/features-overview/developer-tools","routeSlug":"/customer-api.openapi/features-overview/developer-tools","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🛠️ Developer Tools"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/developer-tools"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🛠️ Developer Tools"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comprehensive Documentation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OpenAPI 3.1 specification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interactive API explorer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code examples in cURL, Node.js, PHP, Python"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman collection available"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing & Monitoring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test email sending endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content scoring API for pre-send validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook testing capabilities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed request/response logging"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API performance metrics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"👥 CRM & Contact Management","link":"/customer-api.openapi/features-overview/crm-and-contact-management","routeSlug":"/customer-api.openapi/features-overview/crm-and-contact-management","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"👥 CRM & Contact Management"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/crm-and-contact-management"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"👥 CRM & Contact Management"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact Storage & Organization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store unlimited contacts with email, name, and custom properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in properties: first_name, last_name, phone, company, address, city, state, zip, country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom properties with flexible data types (text, number, date, boolean, URL, email)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag-based organization for easy categorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact source tracking (api, csv_import, form, integration, manual)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact status management (subscribed, pending_confirmation, unsubscribed, bounced, complained)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Segmentation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create dynamic segments with real-time filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced operators: equals, not_equals, contains, not_contains, starts_with, ends_with"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date operators: before, after, between, is_empty, is_not_empty"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric operators: greater_than, less_than, between"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag filtering: has_tag, not_has_tag, has_any_tag, has_all_tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AND/OR logic support for complex queries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segments update automatically as contacts change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by contact properties, tags, status, and source"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Properties System"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two approaches: Centralized definitions or schema-less flexibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define property types, validation rules, and defaults"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required/optional field configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Help text and descriptions for each property"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property groups for organization (contact_info, company_details, custom_fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility control (visible/hidden properties)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type-based validation enforcement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage tracking and statistics per property"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tagging System"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create unlimited tags for contact organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shared tags across all contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk tagging operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag-based filtering and searching"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use tags in segment conditions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track tag usage and statistics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email History & Engagement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View complete email history per contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track opens, clicks, bounces, and complaints"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Engagement metrics and scoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeline view of all interactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter emails by date range and status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV Import & Export"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk import contacts from CSV files"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic field mapping with preview"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation before import"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handle duplicates (skip, update, or create)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export contacts and segments to CSV"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include custom properties in exports"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"💼 Use Cases","link":"/customer-api.openapi/features-overview/use-cases","routeSlug":"/customer-api.openapi/features-overview/use-cases","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"💼 Use Cases"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"features-overview/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"💼 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactional Emails"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Password resets with contact tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order confirmations with customer data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shipping notifications with contact history"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account alerts tied to contact records"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marketing Campaigns"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newsletters to segmented contact lists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotional emails with personalization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Drip campaigns based on contact properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A/B testing across contact segments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application Notifications"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User activity alerts with contact context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System notifications to specific segments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled reports for tagged contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated digests based on contact preferences"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRM Integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sync contacts from your application database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build custom contact forms with validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create lead scoring systems with segments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track customer lifecycle with tags and properties"},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Features Overview"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Features Overview","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic provides enterprise-grade email delivery infrastructure with powerful APIs, deliverability optimization, and comprehensive analytics. Built by developers, for developers."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/features-overview"}],"panels":[]}]}},{"type":"group","label":"Shared Responsibility Model","link":"/customer-api.openapi/shared-responsibility-model","routeSlug":"/customer-api.openapi/shared-responsibility-model","items":[{"type":"link","label":"Platform & Customer Responsibilities","link":"/customer-api.openapi/shared-responsibility-model/platform-and-customer-responsibilities","routeSlug":"/customer-api.openapi/shared-responsibility-model/platform-and-customer-responsibilities","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Platform & Customer Responsibilities"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"shared-responsibility-model/platform-and-customer-responsibilities"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform & Customer Responsibilities"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic operates on a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shared responsibility model"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure optimal email deliverability and compliance. We provide the infrastructure and tools, while you control your content and recipient management."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"📊 Responsibility Matrix","link":"/customer-api.openapi/shared-responsibility-model/responsibility-matrix","routeSlug":"/customer-api.openapi/shared-responsibility-model/responsibility-matrix","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"📊 Responsibility Matrix"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"shared-responsibility-model/responsibility-matrix"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📊 Responsibility Matrix"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Area"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic Responsibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your Responsibility"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliverability & IP Reputation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Maintain clean shared IP pools"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Auto-throttling and rate limiting"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Blocklist monitoring"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• IP warmup scheduling"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Scanner filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Send compliant, opt-in email only"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Avoid spam triggers and blackhat tactics"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Follow warmup guidance"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Monitor sender reputation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Quality"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Pre-send Content Scoring API"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Spam keyword detection"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• HTML validation"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• RFC 8058 compliance checks"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Write high-quality, non-spammy content"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Avoid deceptive or prohibited content"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Test emails before sending at scale"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance (CAN-SPAM, GDPR, CASL)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Auto-insert RFC 8058 One-Click Unsubscribe headers"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Suppression list management"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Unsubscribe request processing"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Data encryption at rest"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Honor unsubscribes in segmentation"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Obtain consent before sending"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Maintain permission-based lists"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Include required legal disclosures"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reputation Monitoring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Automated Health Score tracking"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Bad Sender detection"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Continuous bounce/complaint monitoring"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Proactive alerting"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Improve campaigns when warned"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Maintain good engagement metrics"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Keep bounce/complaint rates low"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain & Email Validation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Domain DNS validation"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Detect risky/disposable domains"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Ensure DKIM/SPF/DMARC alignment"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Email syntax validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Use legitimate sending domains"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Ensure DNS is configured correctly"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Validate recipients before sending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security & Infrastructure"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Secure MTA infrastructure"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Encrypted data storage"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• API authentication"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Bot protection and rate limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Secure API keys"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Maintain account access control"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Follow security best practices"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Rotate keys periodically"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Analytics Accuracy"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Human-vs-scanner classification"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Click/open filtering"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Bot suppression for metrics"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Real tracking data"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Use analytics responsibly"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Interpret human-only statistics correctly"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Don't rely solely on open rates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Abuse Prevention"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Auto-block abusive sending patterns"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Quarantine malicious content"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Stop high-risk sends"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Monitor for policy violations"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Avoid spam/promotional blasts from transactional streams"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Follow terms of service"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Report suspicious activity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce & Complaint Handling"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Automatic bounce suppression"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• FBL complaint handling"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Auto-removal of bad addresses"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Invalid email detection"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Do not re-upload suppressed contacts"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Maintain clean subscriber lists"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Remove inactive recipients"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Streams (Transactional/Marketing)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Enforce stream rules"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Ensure transactional traffic stays clean"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Auto-inject proper headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Choose correct stream type"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Do not mix marketing content in transactional messages"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"• Use appropriate templates"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"✅ What We Handle For You","link":"/customer-api.openapi/shared-responsibility-model/what-we-handle-for-you","routeSlug":"/customer-api.openapi/shared-responsibility-model/what-we-handle-for-you","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"✅ What We Handle For You"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"shared-responsibility-model/what-we-handle-for-you"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ What We Handle For You"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Infrastructure"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": SMTP servers, IP pools, TLS/encryption, DNS setup"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliverability Tools"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Warmup automation, reputation monitoring, content scoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One-Click Unsubscribe headers, suppression lists, bounce handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": API authentication, encrypted storage, bot detection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Analytics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Open/click tracking with scanner filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"✅ What You Control","link":"/customer-api.openapi/shared-responsibility-model/what-you-control","routeSlug":"/customer-api.openapi/shared-responsibility-model/what-you-control","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"✅ What You Control"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"shared-responsibility-model/what-you-control"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ What You Control"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Subject lines, email body, attachments, links"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipients"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": List management, consent tracking, segmentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending Patterns"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Volume, frequency, timing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Legal requirements for your industry and regions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign Strategy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A/B testing, personalization, optimization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🚨 Actions That Violate Your Responsibility","link":"/customer-api.openapi/shared-responsibility-model/actions-that-violate-your-responsibility","routeSlug":"/customer-api.openapi/shared-responsibility-model/actions-that-violate-your-responsibility","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🚨 Actions That Violate Your Responsibility"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"shared-responsibility-model/actions-that-violate-your-responsibility"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🚨 Actions That Violate Your Responsibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These actions may result in account suspension:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending unsolicited emails (spam)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using purchased, scraped, or rented email lists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ignoring high bounce or complaint rates (>5%)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-uploading suppressed email addresses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mixing promotional content in transactional streams"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending phishing, malware, or illegal content"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failing to honor unsubscribe requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spoofing sender identity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"💡 Best Practices","link":"/customer-api.openapi/shared-responsibility-model/best-practices","routeSlug":"/customer-api.openapi/shared-responsibility-model/best-practices","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"💡 Best Practices"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"shared-responsibility-model/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"💡 Best Practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before You Send"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Scoring API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check spam indicators"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Validation API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify recipients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warm up dedicated IPs gradually (use our automated warmup)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test with small batches first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During Campaigns"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor open rates, bounce rates, and complaints in real-time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment your audience for better targeting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Respect send-time preferences"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use clear, honest subject lines"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After Sending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review analytics and Health Scores"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove hard bounces immediately"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Honor unsubscribes within 10 business days (we process instantly)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Improve content based on engagement metrics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"📞 Need Help?","link":"/customer-api.openapi/shared-responsibility-model/need-help","routeSlug":"/customer-api.openapi/shared-responsibility-model/need-help","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"📞 Need Help?"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"shared-responsibility-model/need-help"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📞 Need Help?"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you see warnings in your Health Score or Bad Sender reports, reach out to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"support@mailerlogic.com"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for guidance on improving your sending practices."},"children":[]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Shared Responsibility Model"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Shared Responsibility Model","showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/shared-responsibility-model"}],"panels":[]}]}},{"type":"group","label":"FAQ","link":"/customer-api.openapi/faq","routeSlug":"/customer-api.openapi/faq","items":[{"type":"link","label":"❓ General Questions","link":"/customer-api.openapi/faq/general-questions","routeSlug":"/customer-api.openapi/faq/general-questions","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"❓ General Questions"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/general-questions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❓ General Questions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What is MailerLogic?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic is a comprehensive email delivery platform designed for developers. We provide SMTP servers, REST APIs, tracking, analytics, and deliverability tools to help you send transactional and marketing emails at scale."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike traditional ESPs or sales-focused CRMs, MailerLogic gives you an email-first CRM that unifies contact data, engagement activity, and compliance rules in one system. Your audience data stays accurate automatically, so every email you send is based on real, current behavior."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How is MailerLogic different from other email services?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developer-first design built by developers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time reputation monitoring across all IPs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced content scoring with actionable suggestions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP warm-up automation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transparent pricing with no hidden fees"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What type of emails can I send?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can send:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactional emails (password resets, receipts, notifications)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marketing emails (newsletters, announcements, promotions)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application notifications (user activity, system alerts)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We do NOT allow spam, phishing, purchased/scraped lists, or illegal content."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"💳 Account & Billing","link":"/customer-api.openapi/faq/account-and-billing","routeSlug":"/customer-api.openapi/faq/account-and-billing","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"💳 Account & Billing"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/account-and-billing"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"💳 Account & Billing"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I sign up?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact support@mailerlogic.com to set up your account and receive your API credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What happens if I exceed my monthly limit?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Emails will be queued until your limit resets at the beginning of the next billing cycle. To continue sending immediately, upgrade your plan or purchase additional credits."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I change my plan later?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, you can upgrade or downgrade anytime. Changes take effect at the start of your next billing cycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🌐 Domain Setup & Verification","link":"/customer-api.openapi/faq/domain-setup-and-verification","routeSlug":"/customer-api.openapi/faq/domain-setup-and-verification","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🌐 Domain Setup & Verification"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/domain-setup-and-verification"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🌐 Domain Setup & Verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Why do I need to verify my domain?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain verification proves you own the domain and enables email authentication (SPF, DKIM, DMARC), which significantly improves deliverability and prevents spoofing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How long does DNS verification take?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS changes typically propagate within 1-4 hours, but can take up to 48 hours in some cases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do I need a subdomain or can I use my main domain?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend using a subdomain like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mail.yourdomain.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for sending. This:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Isolates email reputation from your main website"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows independent DNS configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides better tracking and organization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What if my domain verification fails?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check that:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All DNS records are added correctly (no typos)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS changes have propagated (can take up to 48 hours)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are no conflicting SPF or DKIM records"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your DNS provider supports TXT records"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the verify endpoint to see specific failure reasons."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I use multiple domains?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes! You can add multiple domains to your account (based on your plan limits). Each domain has independent statistics and reputation."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"✉️ Sending Emails","link":"/customer-api.openapi/faq/sending-emails","routeSlug":"/customer-api.openapi/faq/sending-emails","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"✉️ Sending Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/sending-emails"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✉️ Sending Emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What's the difference between SMTP and REST API?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Simple HTTP POST endpoint ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for sending emails with JSON payload - recommended for modern applications"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Standard email protocol, works with all email libraries and clients - better for legacy systems or when using existing SMTP libraries"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both methods support campaign tracking for broadcast traffic. When sending bulk/marketing emails via SMTP, declare "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Stream-Type: broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive automatic campaign-level bounce monitoring and reputation protection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What SMTP ports do you support?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Port 587"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (STARTTLS - recommended)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Port 2525"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (alternative STARTTLS)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Port 25 is not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Port 465 (SSL) may be added in the future"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I send attachments?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, attachments are fully supported via SMTP. Maximum email size including attachments is 10MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How many recipients can I send to per email?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum 50 recipients per email. For larger lists, send multiple emails or use our bulk sending features."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What's the sending rate limit?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits are configurable per customer and depend on your IP type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shared IPs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Default 50 emails/second (3,000/minute, 180,000/hour)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dedicated IPs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Default 500 emails/second (30,000/minute, 1.8M/hour)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch Sending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Up to 1,000 recipients per API call"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are starting defaults. Higher limits available for high-volume senders with good reputation. Contact support to increase your throughput."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Why are my emails going to spam?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common causes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain not verified (ensure SPF, DKIM, DMARC configured)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poor content (use content scoring API)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Low engagement rates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High bounce/complaint rates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New IP needs warm-up"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"📊 Tracking & Analytics","link":"/customer-api.openapi/faq/tracking-and-analytics","routeSlug":"/customer-api.openapi/faq/tracking-and-analytics","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"📊 Tracking & Analytics"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/tracking-and-analytics"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📊 Tracking & Analytics"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How does open tracking work?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We insert a tiny invisible 1x1 pixel image in your emails. When the recipient opens the email and images load, we record the open event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires images to be enabled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Privacy features in Apple Mail/Gmail may block tracking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How does click tracking work?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We automatically rewrite all links to route through our tracking domain. When clicked, we record the event and redirect to the original URL (typically under 100ms)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I disable tracking for specific emails?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, tracking can be disabled:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Globally in account settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per email (coming soon via API/SMTP headers)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How long do you store tracking data?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 90 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregated statistics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indefinitely"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed logs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 30 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise plans can request extended retention."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What timezone are timestamps in?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All timestamps are in UTC (Coordinated Universal Time) using ISO 8601 format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-03-15T14:30:00Z"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"📬 Deliverability","link":"/customer-api.openapi/faq/deliverability","routeSlug":"/customer-api.openapi/faq/deliverability","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"📬 Deliverability"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/deliverability"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📬 Deliverability"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What is IP warm-up and do I need it?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP warm-up gradually increases sending volume on a new IP address to build reputation with ISPs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need it for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New dedicated IPs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPs idle for 30+ days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Significantly increased volume"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We automate this process over 2-4 weeks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I improve my sender reputation?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate your domain (SPF, DKIM, DMARC)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send quality content (use content scoring)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maintain good list hygiene"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor engagement metrics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Follow proper IP warm-up schedules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maintain steady sending patterns"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What should my bounce rate be?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Below 2%"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 2-5%"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poor"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Above 5%"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your bounce rate exceeds 10%, we may pause sending to protect your reputation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What should my complaint rate be?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Below 0.1%"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 0.1-0.5%"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poor"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Above 0.5%"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaint rates above 1% may result in account suspension."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do suppression lists work?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppression lists prevent sending to addresses that have:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard bounced"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft bounced repeatedly"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complained (marked as spam)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Been manually added"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic suppression happens immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I whitelist specific addresses?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, you can whitelist addresses to bypass suppression. Use this carefully for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test accounts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal email addresses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verified opt-in addresses only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🔐 Security & Compliance","link":"/customer-api.openapi/faq/security-and-compliance","routeSlug":"/customer-api.openapi/faq/security-and-compliance","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🔐 Security & Compliance"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/security-and-compliance"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔐 Security & Compliance"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do you store my email content?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic stores only the data required to process and deliver your emails:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email metadata (sender, recipient, subject, timestamps)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery events (queued, sent, delivered, opened, clicked, bounced, complained)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Diagnostic information for deliverability troubleshooting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email bodies and attachments are stored temporarily during processing and transmission and are automatically purged once delivery is complete, based on your retention policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise customers may configure:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content retention windows as low as 0–1 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata-only mode (no body persistence)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU-only processing for GDPR-aligned workloads"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This approach follows SOC 2 data minimization principles and GDPR Article 5(1)(c)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Where is my data stored?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic runs entirely on AWS infrastructure. Your data is stored exclusively within the region assigned to your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary GDPR Region (EU customers):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇩🇪 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU-CENTRAL-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Frankfurt, Germany"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frankfurt is our dedicated GDPR-aligned region and preferred by many organizations due to Germany's strong data protection laws and regulatory environment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other supported regions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇺🇸 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US-EAST-1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – Virginia, USA (default for global customers)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data remains within the chosen region unless you explicitly configure cross-regional exports or webhook endpoints outside that region."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Are you SOC 2 compliant?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic is built on BrainCert's established SOC 2 Type II–audited operational framework. This includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strict access control and least-privilege policies"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continuous monitoring and log aggregation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secure SDLC and code review workflows"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Formal incident response and change-management processes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual third-party audits and penetration tests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic inherits these controls and upholds the same standards for security, confidentiality, and availability."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SOC 2 reports are available to Enterprise customers under NDA."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Is MailerLogic GDPR compliant?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes. MailerLogic supports GDPR compliance through:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU data residency (Frankfurt region)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data minimization: only required metadata is retained"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Right to erasure: deletion of logs, metadata, and events upon request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Processing Addendum (DPA) available to all customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encryption in transit and at rest for all stored and transmitted data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No profiling, data sharing, or secondary use of customer information"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic acts as a Data Processor, while you (the customer) remain the Data Controller."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How is my data protected?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We enforce strong encryption and multi-layer security controls:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLS 1.2+ for all SMTP & API communications"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AWS KMS (AES-256) encryption for all data at rest"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated backups stored within the same region"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-tenant isolation for API activity, logs, and sending infrastructure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continuous monitoring for anomalies and abuse"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WAF + rate-limiting + threat detection at the edge"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal access is restricted, audited, logged, and regularly reviewed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Who can access my data?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only a limited set of authorized MailerLogic engineers may access metadata for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliverability analysis"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Abuse or fraud detection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security investigations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-requested troubleshooting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access is governed by SOC 2 controls, MFA, just-in-time access, and extensive logging. MailerLogic never sells data or shares it with third parties."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How long do you retain logs and events?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default retention policies:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery logs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 7–30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook logs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 7 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message content"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": purged immediately after processing (unless retention is configured)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise customers can configure custom retention periods from 1 day to 1 year."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do you provide email authentication and anti-abuse controls?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes. MailerLogic enforces:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPF, DKIM, DMARC validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional BIMI"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated IP/domain warm-up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time spam scoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Throttling and anomaly detection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce, complaint, and reputation monitoring"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounts may be rate-limited or paused if unusual or harmful activity is detected to protect IP reputation and deliverability."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do you sign DPAs and support GDPR audits?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes. We provide:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Processing Addendum (DPA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GDPR-compliant contractual terms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details on sub-processors"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support for DPIAs (Data Protection Impact Assessments)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assistance with customer compliance questionnaires"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do you undergo third-party security testing?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes. MailerLogic undergoes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Annual third-party penetration testing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Continuous vulnerability scanning"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code dependency security monitoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Periodic red-team exercises as part of BrainCert's SOC 2 program"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pen test reports can be shared with Enterprise customers under NDA."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I rotate my API key?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. The old key is invalidated immediately, so update all applications with the new key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I rotate my SMTP password?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials/rotate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint with your X-API-Key header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I implement unsubscribe?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We automatically add:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List-Unsubscribe header (standard email client unsubscribe)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-click unsubscribe (RFC 8058 compliant)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribe link"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also manage suppressions via API."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🔧 Technical Questions","link":"/customer-api.openapi/faq/technical-questions","routeSlug":"/customer-api.openapi/faq/technical-questions","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🔧 Technical Questions"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/technical-questions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔧 Technical Questions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What programming languages do you support?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic works with any language that can speak SMTP or HTTP/REST. We provide examples in cURL, Node.js, Python, and PHP, and you can use any standard HTTP or SMTP client in your stack (Go, Java, Ruby, .NET, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do you have SDKs or libraries?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Official SDKs are coming soon. Until then you can use:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard SMTP libraries (Nodemailer, PHPMailer, Python smtplib, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any HTTP client (Axios, requests, fetch, Guzzle, etc.) to call the REST API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What's your API rate limit?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We separate API request limits from email throughput and quotas."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API request rate limit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"600 requests per minute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies to all REST API endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enforced via HTTP 429 with standard rate-limit headers:"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-RateLimit-Limit: 600\nX-RateLimit-Remaining: 543\nX-RateLimit-Reset: 1733686805\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-RateLimit-Limit: 600\nX-RateLimit-Remaining: 543\nX-RateLimit-Reset: 1733686805\n"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email throughput limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shared IP pool"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 50 emails/second (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dedicated IPs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 500 emails/second (default, after warm-up)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configurable per customer based on reputation and use case"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you exceed the throughput limit, emails are queued, not rejected. Our send engine drains the queue at the optimal rate for your account and IP reputation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily & monthly quotas"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily sending quota"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 50,000 emails/day (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly quota"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 1,000,000 emails/month (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you exceed a quota, new send requests are rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quota_exceeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error until the limit resets or is increased."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch sending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum 1,000 recipients per API call for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/bulk-send"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encourages efficient use of the API and reduces overhead for high-volume senders"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why this design?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Many providers rely on strict per-request limits or return 429 for large send bursts. MailerLogic accepts your requests, queues emails internally, and sends at the correct rate for your configuration and reputation. This lets you run large campaigns reliably without manually managing backoff or throttling logic in your application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need higher limits, contact support with your use case and we'll tune your configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do you have a sandbox environment?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A dedicated sandbox environment is coming soon. In the meantime you can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send small volumes through production using test domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Content Scoring API to validate templates before real sends"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lock sending to internal/whitelisted recipient addresses during integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I test webhooks locally?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use any HTTP tunneling or webhook inspection service, for example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ngrok"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – exposes localhost over HTTPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook.site"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – simple endpoint that shows incoming payloads"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RequestBin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" – captures and inspects webhook requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Point your MailerLogic webhook URL at the generated public URL while you build and debug."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I use MailerLogic behind a firewall?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes. Make sure your firewall allows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound HTTPS on port 443 for API calls"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound SMTP on ports 587 or 2525 for sending via SMTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound HTTPS on your webhook endpoint if you want to receive events"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What's your uptime SLA?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We target 99.9% uptime. Enterprise plans include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contractual SLA guarantees"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Priority & on-call support"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident notifications via our status page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status page: https://status.mailerlogic.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"🛠️ Troubleshooting","link":"/customer-api.openapi/faq/troubleshooting","routeSlug":"/customer-api.openapi/faq/troubleshooting","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"🛠️ Troubleshooting"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/troubleshooting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🛠️ Troubleshooting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Why can't I authenticate via SMTP?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using correct SMTP credentials (from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using STARTTLS on port 587 or 2525"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No firewall blocking outbound SMTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials not expired"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Why are my API requests failing with 401?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible causes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid API key (check key is correct and not expired)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wrong header (use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-Key: YOUR_KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for customer endpoints, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer YOUR_KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for events API)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using a key from a different customer account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Why am I getting 429 errors?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You've exceeded the API rate limit (600 requests per minute). Our system returns 429 for high-frequency non-send endpoints (stats, events, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accept and queue emails instead of returning 429, unless your account is hard-blocked or quota is exceeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wait for the reset time indicated in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-RateLimit-Reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or reduce your request frequency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Why aren't my opens/clicks being tracked?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking enabled on your account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTML email (tracking requires HTML)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images enabled in recipient's email client (for opens)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Privacy features may block tracking (Apple Mail, Gmail)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Why is my email still queued?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Emails may be queued due to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP warm-up limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Daily sending limits during warm-up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain throttling"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Respecting recipient domain rate limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quota exceeded"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Monthly limit reached"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reputation issues"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Automatic throttling due to bounces/complaints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"👥 CRM & Contact Management","link":"/customer-api.openapi/faq/crm-and-contact-management","routeSlug":"/customer-api.openapi/faq/crm-and-contact-management","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"👥 CRM & Contact Management"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/crm-and-contact-management"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"👥 CRM & Contact Management"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What is the Contact Management feature?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic includes built-in CRM functionality for storing, organizing, and segmenting your contacts. You can store unlimited contacts (based on your tier), add custom properties, create tags, and build dynamic segments - all through our API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How many contacts can I store?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact limits vary by plan. Please check the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.mailerlogic.com/pricing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic pricing page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for current plan limits and features."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact usage is tracked in real-time and enforced automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What's the difference between contacts and suppressions?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Your contact database (CRM). Includes subscribed, unsubscribed, bounced, and complained contacts. Used for segmentation and email history tracking."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppressions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Addresses that should never receive emails (hard bounces, spam complaints, manual blocks). Prevents sending to invalid/problematic addresses."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can have a contact who is also suppressed - they exist in your CRM but won't receive emails until removed from suppressions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What data can I store with each contact?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in properties:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email (required, unique)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first_name, last_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone, company"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address, city, state, zip, country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status (subscribed, pending_confirmation, unsubscribed, bounced, complained)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source (api, csv_import, form, integration, manual)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom properties:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add unlimited custom fields with flexible data types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported types: text, textarea, number, date, boolean, url, email, phone, select"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define validation rules and default values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group properties into logical categories"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do segments work?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segments are dynamic filters that automatically update as contacts change:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create filters with advanced operators (equals, contains, greater_than, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Combine multiple conditions with AND/OR logic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by contact properties, tags, status, and source"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segments update in real-time - no manual refresh needed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get contact counts instantly via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export segment results to CSV"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"All subscribed contacts in California with email ending in .edu\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Contacts tagged 'premium' who opened an email in last 30 days\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Contacts with company field not empty and status = subscribed\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What segment operators are available?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equals, not_equals, contains, not_contains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"starts_with, ends_with, is_empty, is_not_empty"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equals, not_equals, greater_than, less_than, between"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before, after, between, is_empty, is_not_empty"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"has_tag, not_has_tag, has_any_tag, has_all_tags"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do tags work?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are simple labels you can add to contacts for organization:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create unlimited tags (e.g., \"newsletter\", \"customer\", \"vip\", \"trial\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add multiple tags to any contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are shared across all contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use tags in segment filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk tag operations supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track tag usage and statistics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I import contacts in bulk?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes! CSV import is fully supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload CSV files with any column structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic field mapping with preview"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation before import (email format, required fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate handling options (skip, update, or create new)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import custom properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag contacts during import"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get import status and error reports"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I export contacts?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, you can export:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All contacts or specific segments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include/exclude custom properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV format ready for Excel or Google Sheets"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export includes all built-in and custom fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I track email history per contact?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each contact automatically tracks:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All emails sent to that contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens, clicks, bounces, and complaints"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Engagement metrics and scoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeline view of all interactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by date range and email status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/customer/contacts/{contact_id}/emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What are custom property definitions?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic supports two approaches for custom properties:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Centralized Definitions (Recommended for CRM)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define properties once with type, validation, and help text"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enforce consistency across all contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dropdown options for select fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required/optional field configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Better for structured data and forms"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Schema-less (Flexible)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add any property to any contact without pre-definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum flexibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No type enforcement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Better for dynamic or unstructured data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How many custom properties can I add?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There's no hard limit on custom properties, but we recommend:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep under 50 properties for performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use property groups to organize related fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use tags for simple categorization instead of boolean properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consider data types carefully (text vs textarea, number vs string)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I update contacts in bulk?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes, bulk operations are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk tag/untag contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk update properties (coming soon)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk delete contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk status changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations via API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For large updates, use CSV import with \"update\" mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: What happens when I reach my contact limit?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can still view and manage existing contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New contact creation will fail with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit_exceeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consider upgrading to increase your limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can delete unused contacts to free up space"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do contact statuses work?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts have four statuses:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscribed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Active contact, can receive emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unsubscribed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Contact opted out, should not receive marketing emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bounced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Email address bounced (hard bounce), cannot receive emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complained"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Contact marked email as spam, should not receive emails"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status changes automatically based on email events, or you can update manually via API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Do contacts integrate with email sending?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes! When sending emails:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference contacts by email or contact_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use contact properties for personalization (merge tags)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic engagement tracking linked to contact record"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounces and complaints update contact status automatically"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build segments for targeted campaigns"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I use segments for email campaigns?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absolutely! Segments are designed for this:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a segment with your targeting criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get segment contact count via API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export segment contacts or send directly to all contacts in segment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment auto-updates, so recurring campaigns always target current matches"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"# Get contacts in a segment\nGET /api/v1/customer/segments/{segment_id}/contacts\n\n# Send to all contacts in segment\nPOST /api/v1/batch\n{\n  \"segment_id\": \"segment-uuid\",\n  \"subject\": \"Monthly Newsletter\",\n  \"html\": \"<html>...</html>\"\n}\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"# Get contacts in a segment\nGET /api/v1/customer/segments/{segment_id}/contacts\n\n# Send to all contacts in segment\nPOST /api/v1/batch\n{\n  \"segment_id\": \"segment-uuid\",\n  \"subject\": \"Monthly Newsletter\",\n  \"html\": \"<html>...</html>\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: How do I handle GDPR data deletion requests?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To comply with GDPR right to erasure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete the contact via API: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /api/v1/customer/contacts/{contact_id}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This removes:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact record and all properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags associated with the contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email history linked to the contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal data from our system"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email event logs are anonymized (email address removed) but aggregate statistics remain for deliverability purposes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Q: Can I sync contacts from my CRM/database?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes! Common integration patterns:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook-based sync"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Your CRM webhooks to MailerLogic when contacts change"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled sync"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Periodic API calls to sync contact updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV sync"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Export from your CRM, import to MailerLogic"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zapier/Make"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use integration platforms for automated sync"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most customers sync nightly or in real-time via webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"💬 Support","link":"/customer-api.openapi/faq/support","routeSlug":"/customer-api.openapi/faq/support","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"💬 Support"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"faq/support"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"💬 Support"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": support@mailerlogic.com (24-hour response on business days)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": https://support.mailerlogic.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": https://status.mailerlogic.com"},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"FAQ"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FAQ","showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/faq"}],"panels":[]}]}},{"type":"separator","label":"Email Infrastructure API","content":null},{"type":"group","label":"Email Sending","link":"/customer-api.openapi/email-sending","routeSlug":"/customer-api.openapi/email-sending","items":[{"type":"link","label":"Stream Types & IP Routing","link":"/customer-api.openapi/email-sending/stream-types-and-ip-routing","routeSlug":"/customer-api.openapi/email-sending/stream-types-and-ip-routing","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Stream Types & IP Routing"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"email-sending/stream-types-and-ip-routing"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream Types & IP Routing"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stream-based IP routing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to optimize deliverability by sending different types of emails through dedicated IP pools."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Available Stream Types","link":"/customer-api.openapi/email-sending/available-stream-types","routeSlug":"/customer-api.openapi/email-sending/available-stream-types","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Available Stream Types"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email-sending/available-stream-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Stream Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Time-sensitive, high-priority emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Password resets, 2FA codes, order confirmations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optimized for highest deliverability"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for mission-critical emails"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Marketing campaigns and newsletters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newsletters, promotional emails, announcements"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optimized for high-volume sending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ideal for promotional campaigns"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) - General purpose emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notifications, alerts, general correspondence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balanced approach for mixed content types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good default for most use cases"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"How to Use Stream Types","link":"/customer-api.openapi/email-sending/how-to-use-stream-types","routeSlug":"/customer-api.openapi/email-sending/how-to-use-stream-types","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"How to Use Stream Types"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email-sending/how-to-use-stream-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to Use Stream Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request body or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Stream-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to your email (see SMTP section)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic Selection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If not specified, the default depends on the channel:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /bulk-send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system automatically optimizes delivery for each stream type to ensure the best inbox placement and deliverability for your emails."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Tags vs Stream Types","link":"/customer-api.openapi/email-sending/tags-vs-stream-types","routeSlug":"/customer-api.openapi/email-sending/tags-vs-stream-types","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Tags vs Stream Types"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email-sending/tags-vs-stream-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags vs Stream Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): Controls delivery optimization and inbox placement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): Organizes emails for analytics and filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Stream type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" optimizes for maximum reliability, while tag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"password-reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" helps you filter these emails in reports."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Best Practices","link":"/customer-api.openapi/email-sending/best-practices","routeSlug":"/customer-api.openapi/email-sending/best-practices","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Best Practices"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email-sending/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DO:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for password resets, 2FA, order confirmations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for newsletters and marketing campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Combine stream types with tags for better organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test your integration with different stream types"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DON'T:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send marketing emails through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stream"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mix high-volume campaigns with transactional emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use tags as a substitute for stream types"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Email Lifecycle Events","link":"/customer-api.openapi/email-sending/email-lifecycle-events","routeSlug":"/customer-api.openapi/email-sending/email-lifecycle-events","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Email Lifecycle Events"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"email-sending/email-lifecycle-events"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Lifecycle Events"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email lifecycle events provide detailed tracking information about each stage of an email's journey — including delivery, opens, clicks, bounces, complaints, and other post-send activity. These events are stored as historical records and can be retrieved programmatically through the Lifecycle Events API."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Important","link":"/customer-api.openapi/email-sending/important","routeSlug":"/customer-api.openapi/email-sending/important","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Important"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email-sending/important"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to historical lifecycle event data is available only for customers whose subscription tier includes this feature."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All customers will still receive the standard send-time response from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint, but only eligible tiers can query historical lifecycle data via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Standard Send Response","link":"/customer-api.openapi/email-sending/standard-send-response","routeSlug":"/customer-api.openapi/email-sending/standard-send-response","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Standard Send Response"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email-sending/standard-send-response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard Send Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The synchronous response from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is available to all customers, regardless of subscription level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example standard response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"messageId\": \"abcd1234\",\n  \"status\": \"queued\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"messageId\": \"abcd1234\",\n  \"status\": \"queued\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response confirms that the email has been accepted for processing but does not include historical or post-send engagement data."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Tracked Events","link":"/customer-api.openapi/email-sending/tracked-events","routeSlug":"/customer-api.openapi/email-sending/tracked-events","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Tracked Events"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email-sending/tracked-events"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracked Events"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After sending an email, the following events are tracked automatically:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"queued"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Email accepted and queued for delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Email handed off to recipient server"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient server accepted the email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bounce"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Email rejected by recipient server"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"open"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient opened the email (requires tracking enabled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"click"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient clicked a link (requires tracking enabled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complaint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient marked as spam"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unsubscribe"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient unsubscribed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query these events via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint (enterprise feature)."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Automatic Retry Policy","link":"/customer-api.openapi/email-sending/automatic-retry-policy","routeSlug":"/customer-api.openapi/email-sending/automatic-retry-policy","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Automatic Retry Policy"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"email-sending/automatic-retry-policy"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic Retry Policy"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed emails are automatically retried with exponential backoff:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft bounces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Retried up to 3 times over 24 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Temporary failures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Retried up to 5 times over 48 hours"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard bounces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Not retried (permanent failure)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry Schedule:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Immediate retry (0 minutes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second attempt (15 minutes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Third attempt (1 hour)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fourth attempt (4 hours)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Final attempt (24 hours)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After all retries are exhausted, the email status becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Send a single email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-sending/paths/~1api~1v1~1send/post","routeSlug":"/customer-api.openapi/email-sending/paths/~1api~1v1~1send/post","metadata":{"seo":{"title":"Send a single email","description":"Send a single transactional or marketing email via REST API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Send a single email","isWebhook":false,"pointer":"/paths/~1api~1v1~1send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a single email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a single transactional or marketing email via REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simple API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for sending emails with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic queuing and delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in tracking (opens & clicks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File attachments (PDF, ZIP, images, documents)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calendar invites (iCal/RFC 5545)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template variable support"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full bounce and complaint handling"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verified sending domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active customer account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid API key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain selection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", MailerLogic uses the domain part of that address as the sending domain unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is explicitly supplied. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, MailerLogic uses your first verified domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream enforcement:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The endpoint defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". MailerLogic"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monitors repeated single-recipient sends for deterministic bulk-like behavior."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted traffic declared transactional that matches this pattern may be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reclassified to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to protect transactional IP reputation. Hard"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"velocity or quota limits are still rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotent retries:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pass an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body field) with a unique value per logical send. If the request is retried"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the same key within 24 hours, the original response is returned with an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Idempotent-Replay: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and no duplicate email is sent. A retry"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that arrives while the original request is still processing receives"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — wait and retry. Keys are scoped to your account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses with 5xx status are not stored, so failed requests can be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retried safely with the same key."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_221","description":"Unique key for safe retries. Retrying with the same key within 24 hours\nreplays the original response instead of sending a duplicate email.\n","example":"order-12345-receipt"}],"pointer":"/paths/~1api~1v1~1send/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_222","exampleIds":["paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/simple","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/broadcast","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/with_attachments","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/calendar_invite","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/combined"]}},"schemaId":"schema_222","exampleIds":["paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/simple","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/broadcast","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/with_attachments","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/calendar_invite","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/combined"],"pointer":"/paths/~1api~1v1~1send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/send","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"order-12345-receipt","schemaId":"schema_221"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_222","exampleIds":["paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/simple","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/broadcast","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/with_attachments","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/calendar_invite","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/combined"]}},"responseCodes":["200","400","403","404","500"],"pointer":"/api/v1/send","href":"email-sending/paths/~1api~1v1~1send/post","summary":"Send a single email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_222","exampleIds":["paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/simple","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/broadcast","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/with_attachments","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/calendar_invite","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/combined"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_222","exampleIds":["paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/simple","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/broadcast","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/with_attachments","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/calendar_invite","paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/combined"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email queued successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_223","exampleIds":["paths/~1api~1v1~1send/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_223","exampleIds":["paths/~1api~1v1~1send/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad request - validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/invalid_email","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/domain_mismatch"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/invalid_email","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/domain_mismatch"]},{"code":"403","description":"Forbidden - account or domain issue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/account_paused","paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/domain_not_verified"]}},"schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/account_paused","paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/domain_not_verified"]},{"code":"404","description":"Not found - customer or domain doesn't exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/domain_not_found"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/domain_not_found"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/500/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_223","exampleIds":["paths/~1api~1v1~1send/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_223","exampleIds":["paths/~1api~1v1~1send/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/invalid_email","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/domain_mismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/invalid_email","paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/domain_mismatch"]}}},{"code":"403","schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/account_paused","paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/domain_not_verified"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/account_paused","paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/domain_not_verified"]}}},{"code":"404","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/domain_not_found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/domain_not_found"]}}},{"code":"500","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1send/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-sending/paths/~1api~1v1~1send/post"}],"panels":[]}]},"httpPath":"/api/v1/send"},{"label":"Send batch of different emails","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-sending/paths/~1api~1v1~1batch/post","routeSlug":"/customer-api.openapi/email-sending/paths/~1api~1v1~1batch/post","metadata":{"seo":{"title":"Send batch of different emails","description":"Send up to 500 completely different emails in a single API call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Send batch of different emails","isWebhook":false,"pointer":"/paths/~1api~1v1~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send batch of different emails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send up to 500 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completely different emails"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a single API call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch sending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where each email can have:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different recipient"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different subject"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different content"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File attachments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calendar invites"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perfect for sending multiple transactional emails at once (order confirmations, password resets, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum 500 emails per batch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each email validated independently"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed emails don't affect successful ones"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending different transactional emails simultaneously"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mixed email types in one API call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High-volume transactional sending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not for:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Newsletter-style emails with same content → Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/bulk-send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotent retries:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pass an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body field) so a retried batch is not sent twice. Retrying with the same key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within 24 hours replays the original response ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Idempotent-Replay: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of re-sending the batch. A retry while the original is still"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processing returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Keys are scoped to your account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_221","description":"Unique key for safe retries. Retrying with the same key within 24 hours\nreplays the original response instead of re-sending the batch.\n","example":"batch-2026-07-08-run-1"}],"pointer":"/paths/~1api~1v1~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_226","exampleIds":["paths/~1api~1v1~1batch/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_226","exampleIds":["paths/~1api~1v1~1batch/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1batch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/batch","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"batch-2026-07-08-run-1","schemaId":"schema_221"}],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_226","exampleIds":["paths/~1api~1v1~1batch/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","403","404","429","500"],"pointer":"/api/v1/batch","href":"email-sending/paths/~1api~1v1~1batch/post","summary":"Send batch of different emails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_226","exampleIds":["paths/~1api~1v1~1batch/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_226","exampleIds":["paths/~1api~1v1~1batch/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch processed (may include partial failures)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/partial_success"]}},"schemaId":"schema_227","exampleIds":["paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/partial_success"]},{"code":"400","description":"Bad request or all emails failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/batch_size_exceeded","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/all_failed"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/batch_size_exceeded","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/all_failed"]},{"code":"403","description":"Account paused","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1batch/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1batch/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Customer or domain not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/no_verified_domains"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/no_verified_domains"]},{"code":"429","description":"Quota exceeded. The batch would exceed your daily or monthly send limit, so the entire batch is rejected (all-or-nothing). Limits are enforced atomically at accept time, so parallel requests cannot collectively exceed the cap.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1api~1v1~1batch/post/responses/429/content/application~1json/example"]}},"schemaId":"schema_228","exampleIds":["paths/~1api~1v1~1batch/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/500/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_227","exampleIds":["paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/partial_success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/partial_success"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/batch_size_exceeded","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/all_failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/missing_fields","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/batch_size_exceeded","paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/all_failed"]}}},{"code":"403","schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1batch/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1api~1v1~1batch/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/no_verified_domains"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/customer_not_found","paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/no_verified_domains"]}}},{"code":"429","schemaId":"schema_228","exampleIds":["paths/~1api~1v1~1batch/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228","exampleIds":["paths/~1api~1v1~1batch/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1batch/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-sending/paths/~1api~1v1~1batch/post"}],"panels":[]}]},"httpPath":"/api/v1/batch"},{"label":"Send bulk emails (mail merge)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-sending/paths/~1api~1v1~1bulk-send/post","routeSlug":"/customer-api.openapi/email-sending/paths/~1api~1v1~1bulk-send/post","metadata":{"seo":{"title":"Send bulk emails (mail merge)","description":"Send the same email template to multiple recipients with personalization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Send bulk emails (mail merge)","isWebhook":false,"pointer":"/paths/~1api~1v1~1bulk-send/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send bulk emails (mail merge)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same email template"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to multiple recipients with personalization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mail merge functionality"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newsletters with personalized greetings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marketing campaigns with custom variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk transactional emails with recipient-specific data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template variables: Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{variable}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax in subject, HTML, and text"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in placeholders: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for unsubscribe links"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-recipient personalization via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vars"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic variable substitution for each recipient"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single template, many recipients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File attachments (same for all recipients)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calendar invites (same for all recipients)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended: Up to 10,000 recipients per call"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each recipient gets their own personalized copy"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newsletter campaigns: \"Hi {{name}}, check out our new {{product}}...\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotional emails with unique discount codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event invitations with personalized details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in Placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Secure unsubscribe link (unique per recipient)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not for:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Different emails to each recipient → Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229","pointer":"/paths/~1api~1v1~1bulk-send/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/bulk-send","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_229"}},"responseCodes":["202","400","401","500"],"pointer":"/api/v1/bulk-send","href":"email-sending/paths/~1api~1v1~1bulk-send/post","summary":"Send bulk emails (mail merge)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_229"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Bulk send request accepted and queued for delivery","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_230","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/202/content/application~1json/example"]},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Authentication failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/401/content/application~1json/example"]}},"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/500/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1bulk-send/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_230","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1bulk-send/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-sending/paths/~1api~1v1~1bulk-send/post"}],"panels":[]}]},"httpPath":"/api/v1/bulk-send"},{"label":"Send email to a segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-sending/paths/~1api~1v1~1send-segment/post","routeSlug":"/customer-api.openapi/email-sending/paths/~1api~1v1~1send-segment/post","metadata":{"seo":{"title":"Send email to a segment","description":"Send emails to contacts matching segment criteria using dynamic segmentation or saved segments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Send email to a segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1send-segment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send email to a segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send emails to contacts matching segment criteria using dynamic segmentation or saved segments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send to saved segments (by segment_id)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send with inline segment filters (dynamic targeting)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW: Exclude unengaged contacts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (improve deliverability & engagement metrics)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account-level merge fields (same for all recipients)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact-level personalization (name, email, custom properties)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous processing (returns immediately, processes in background)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unengaged Filtering (NEW):"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically exclude contacts who haven't opened or clicked any email in the last N days."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This improves sender reputation, reduces costs, and increases engagement rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_unengaged: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unengaged_days: 90"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (recommended)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts with NO email activity in the lookback period are excluded"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perfect for newsletters, promotions, and regular campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable for transactional emails (password resets, receipts, etc.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge Fields:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account-level"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_merge_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - same value for all recipients (e.g., company_name, promo_code)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact-level"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Automatically available ({{name}}, {{email}}, {{first_name}}, {{last_name}}, plus all custom properties)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segmentation Options:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use existing segment → Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"segment_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Dynamic filters → Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"segment_filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with filter conditions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment Filter Structure:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"match_type\": \"all\",  // \"all\" (AND) or \"any\" (OR)\n  \"filter_conditions\": [\n    {\n      \"property\": \"status\",\n      \"operator\": \"equals\",\n      \"value\": \"subscribed\"\n    },\n    {\n      \"property\": \"tags\",\n      \"operator\": \"contains\",\n      \"value\": \"vip\"\n    }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"match_type\": \"all\",  // \"all\" (AND) or \"any\" (OR)\n  \"filter_conditions\": [\n    {\n      \"property\": \"status\",\n      \"operator\": \"equals\",\n      \"value\": \"subscribed\"\n    },\n    {\n      \"property\": \"tags\",\n      \"operator\": \"contains\",\n      \"value\": \"vip\"\n    }\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equals, not_equals, contains, not_contains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater_than, less_than, greater_than_or_equal, less_than_or_equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_empty, is_not_empty, is_true, is_false"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max 10 filter groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max 20 filters per group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max 100 total filters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newsletter to all subscribed contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotional email to contacts tagged \"vip\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-engagement campaign for inactive subscribers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product updates to contacts with specific custom properties"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"schemaId":"schema_232","pointer":"/paths/~1api~1v1~1send-segment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/send-segment","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_232"}},"responseCodes":["202","400","401","404"],"pointer":"/api/v1/send-segment","href":"email-sending/paths/~1api~1v1~1send-segment/post","summary":"Send email to a segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_232","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_232"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Segment email queued for processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233"}},"schemaId":"schema_233"},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_234"}},"schemaId":"schema_234"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1send-segment/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1send-segment/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_236"}},"schemaId":"schema_236"}],"pointer":"/paths/~1api~1v1~1send-segment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_233","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_233"}}},{"code":"400","schemaId":"schema_234","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_234"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1send-segment/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1send-segment/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_236","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_236"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-sending/paths/~1api~1v1~1send-segment/post"}],"panels":[]}]},"httpPath":"/api/v1/send-segment"},{"label":"Send test email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-sending/paths/~1api~1v1~1customer~1test-email/post","routeSlug":"/customer-api.openapi/email-sending/paths/~1api~1v1~1customer~1test-email/post","metadata":{"seo":{"title":"Send test email","description":"Send a test email with intelligent defaults based on domain health."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Send test email","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1test-email/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send test email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a test email with intelligent defaults based on domain health."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports 3 test modes: basic, standard, full"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-disables tracking based on test mode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic spam word detection (not comprehensive scoring)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns warnings and recommendations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides next steps for new domains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test Modes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"basic"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Disables all tracking regardless of request. Best for new domains."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Disables open tracking, enables click tracking. For warming domains."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Honors your tracking preferences. For established domains."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practice:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/customer/domains/test-readiness/:domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the recommended test mode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review warnings before sending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Follow next steps provided in response"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Analysis:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"analyze_content: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive basic spam word warnings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When HTML is supplied without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, the test send derives its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plain-text MIME alternative using the same generator as bulk campaign"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery. This keeps test-message MIME structure representative of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production send path."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint performs only basic spam detection. For comprehensive content"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scoring with detailed analysis, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/content-score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (subject to tier limits)."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/basic_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/standard_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/full_test"]}},"schemaId":"schema_237","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/basic_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/standard_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/full_test"],"pointer":"/paths/~1api~1v1~1customer~1test-email/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/test-email","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/basic_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/standard_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/full_test"]}},"responseCodes":["201","400","401","403","404","500"],"pointer":"/api/v1/customer/test-email","href":"email-sending/paths/~1api~1v1~1customer~1test-email/post","summary":"Send test email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_237","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/basic_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/standard_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/full_test"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/basic_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/standard_test","paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/full_test"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Test email queued successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_238","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Account suspended or domain paused","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239"}},"schemaId":"schema_239"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1test-email/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_238","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_239","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1test-email/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-sending/paths/~1api~1v1~1customer~1test-email/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/test-email"},{"label":"Test email deliverability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-sending/testdeliverability","routeSlug":"/customer-api.openapi/email-sending/testdeliverability","metadata":{"seo":{"title":"Test email deliverability","description":"Comprehensive email deliverability testing that analyzes your email content for:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testDeliverability","name":"Test email deliverability","isWebhook":false,"pointer":"/paths/~1api~1v1~1test-deliverability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test email deliverability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comprehensive email deliverability testing that analyzes your email content for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spam score"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using SpamAssassin (industry standard)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blacklist status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" across major RBLs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link safety"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scanning (phishing, malware, redirects)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accessibility"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" compliance (alt text, semantic HTML)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content analysis"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (word count, readability, image ratio)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test emails BEFORE sending to large lists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fix high spam scores (aim for < 5.0)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure all links are safe and valid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add alt text to images for accessibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance text/image ratio (avoid image-only emails)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Average test time: 2-5 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cached blacklist checks for speed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time spam scoring"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_240"}},"schemaId":"schema_240","pointer":"/paths/~1api~1v1~1test-deliverability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/test-deliverability","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_240"}},"responseCodes":["200","400","401","429","503"],"pointer":"/api/v1/test-deliverability","href":"email-sending/testdeliverability","openApiOperationId":"testDeliverability","summary":"Test email deliverability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_240","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_240"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deliverability test completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}},"schemaId":"schema_241"},{"code":"400","description":"Invalid request (missing required fields)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}},"schemaId":"schema_242"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1test-deliverability/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1test-deliverability/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"429","description":"Monthly test limit exceeded for your tier","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}},"schemaId":"schema_243"},{"code":"503","description":"SpamAssassin service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}},"schemaId":"schema_244"}],"pointer":"/paths/~1api~1v1~1test-deliverability/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_241","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}}},{"code":"400","schemaId":"schema_242","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1test-deliverability/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1test-deliverability/post/responses/401/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_243","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}}},{"code":"503","schemaId":"schema_244","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-sending/testdeliverability"}],"panels":[]}]},"httpPath":"/api/v1/test-deliverability"}],"content":{"contentType":"group","meta":{"name":"Email Sending"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Sending","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send transactional and marketing emails via REST API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simple API for sending individual emails with full tracking support."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/send","summary":"Send a single email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-sending/paths/~1api~1v1~1send/post","deprecated":false},{"title":"/api/v1/batch","summary":"Send batch of different emails","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-sending/paths/~1api~1v1~1batch/post","deprecated":false},{"title":"/api/v1/bulk-send","summary":"Send bulk emails (mail merge)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-sending/paths/~1api~1v1~1bulk-send/post","deprecated":false},{"title":"/api/v1/send-segment","summary":"Send email to a segment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-sending/paths/~1api~1v1~1send-segment/post","deprecated":false},{"title":"/api/v1/customer/test-email","summary":"Send test email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-sending/paths/~1api~1v1~1customer~1test-email/post","deprecated":false},{"title":"/api/v1/test-deliverability","summary":"Test email deliverability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-sending/testdeliverability","deprecated":false}]}]}]}]}},{"type":"group","label":"Campaign Reports","link":"/customer-api.openapi/campaign-reports","routeSlug":"/customer-api.openapi/campaign-reports","items":[{"label":"Get campaign overview report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1report/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1report/get","metadata":{"seo":{"title":"Get campaign overview report","description":"Get comprehensive campaign statistics including sends, opens, clicks, bounces, and calculated rates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get campaign overview report","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign overview report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get comprehensive campaign statistics including sends, opens, clicks, bounces, and calculated rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Campaign Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send to Segment:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/send-segment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Newsletter:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk_session_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") UUID returned from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/bulk-send"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch Send:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not supported (use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/stats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For bulk-send campaigns, use the UUID directly (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"f1e2d3c4-b5a6-7890-cdef-123456789abc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), NOT a prefixed string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metrics Included:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total sent, delivered, bounced (hard/soft breakdown)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique opens, total opens, open rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique clicks, total clicks, click rate, click-to-open rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaints and unsubscribes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign date range (first/last sent)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scanner Filtering:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to exclude bot/scanner activity for accurate engagement metrics."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign ID - either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/send-segment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk_session_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/bulk-send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]}]}],"required":true,"example":"f1e2d3c4-b5a6-7890-cdef-123456789abc"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_246","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter opens/clicks by scanner activity:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Include all activity (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Exclude scanner/bot opens and clicks (recommended)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only scanner/bot activity"},"children":[]}]}]}]}]}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/report","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"example":"f1e2d3c4-b5a6-7890-cdef-123456789abc","schemaId":"schema_245"}],"query":[{"name":"filter","in":"query","required":false,"schemaId":"schema_246"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/campaigns/{campaignId}/report","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1report/get","summary":"Get campaign overview report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Campaign report retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}},"schemaId":"schema_247"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Campaign not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_248"}},"schemaId":"schema_248"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_247","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_248","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_248"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1report/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/report"},{"label":"Get contacts who opened","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1opened/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1opened/get","metadata":{"seo":{"title":"Get contacts who opened","description":"Get list of contacts who opened the campaign email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get contacts who opened","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contacts who opened","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get list of contacts who opened the campaign email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perfect for drill-down functionality where clicking the opens count"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shows the actual contacts who opened."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact details (email, name, company, phone)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First and last open timestamps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of opens per contact"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign ID (job_id from send-segment)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_246","description":"Filter by scanner activity"},{"name":"limit","in":"query","schemaId":"schema_249","description":"Number of results per page"},{"name":"offset","in":"query","schemaId":"schema_250","description":"Pagination offset"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/contacts/opened","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"filter","in":"query","schemaId":"schema_246"},{"name":"limit","in":"query","schemaId":"schema_249"},{"name":"offset","in":"query","schemaId":"schema_250"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/contacts/opened","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1opened/get","summary":"Get contacts who opened"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contacts retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_251"}},"schemaId":"schema_251"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_251","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_251"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1opened/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/contacts/opened"},{"label":"Get contacts who clicked","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1clicked/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1clicked/get","metadata":{"seo":{"title":"Get contacts who clicked","description":"Get list of contacts who clicked links in the campaign."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get contacts who clicked","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contacts who clicked","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get list of contacts who clicked links in the campaign.\n\nPerfect for drill-down functionality where clicking the clicks count\nshows the actual contacts who clicked.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_246"},{"name":"limit","in":"query","schemaId":"schema_249"},{"name":"offset","in":"query","schemaId":"schema_250"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/contacts/clicked","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"filter","in":"query","schemaId":"schema_246"},{"name":"limit","in":"query","schemaId":"schema_249"},{"name":"offset","in":"query","schemaId":"schema_250"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/contacts/clicked","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1clicked/get","summary":"Get contacts who clicked"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contacts retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_252"}},"schemaId":"schema_252"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_252","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_252"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1clicked/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/contacts/clicked"},{"label":"Get contacts whose emails bounced","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1bounced/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1bounced/get","metadata":{"seo":{"title":"Get contacts whose emails bounced","description":"Get list of contacts whose emails bounced with bounce type and reason."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get contacts whose emails bounced","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contacts whose emails bounced","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get list of contacts whose emails bounced with bounce type and reason.\n\nUseful for identifying invalid addresses and cleaning your contact list.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"bounce_type","in":"query","schemaId":"schema_253","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by bounce type (hard=permanent, soft=temporary)"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_254"},{"name":"offset","in":"query","schemaId":"schema_250"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/contacts/bounced","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"bounce_type","in":"query","schemaId":"schema_253"},{"name":"limit","in":"query","schemaId":"schema_254"},{"name":"offset","in":"query","schemaId":"schema_250"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/contacts/bounced","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1bounced/get","summary":"Get contacts whose emails bounced"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bounced contacts retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}},"schemaId":"schema_255"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_255","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1bounced/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/contacts/bounced"},{"label":"Get contacts whose emails failed delivery","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1failed/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1failed/get","metadata":{"seo":{"title":"Get contacts whose emails failed delivery","description":"Get list of contacts whose emails failed delivery after exhausting retries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get contacts whose emails failed delivery","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contacts whose emails failed delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get list of contacts whose emails failed delivery after exhausting retries.\n\nThese are temporary failures (like timeouts or throttling) that were retried multiple times but never succeeded.\nDifferent from bounces which are permanent failures.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_254"},{"name":"offset","in":"query","schemaId":"schema_250"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/contacts/failed","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"limit","in":"query","schemaId":"schema_254"},{"name":"offset","in":"query","schemaId":"schema_250"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/contacts/failed","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1failed/get","summary":"Get contacts whose emails failed delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Failed contacts retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}},"schemaId":"schema_256"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_256","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1failed/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/contacts/failed"},{"label":"Get all campaign recipients with status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1recipients/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1recipients/get","metadata":{"seo":{"title":"Get all campaign recipients with status","description":"Get comprehensive list of all campaign recipients with their delivery status, engagement data (opens/clicks), and bounce information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get all campaign recipients with status","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all campaign recipients with status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get comprehensive list of all campaign recipients with their delivery status,\nengagement data (opens/clicks), and bounce information.\n\nSupports filtering by status and searching by email/name.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_257","description":"Filter by delivery status"},{"name":"search","in":"query","schemaId":"schema_258","description":"Search by email, first name, or last name"},{"name":"limit","in":"query","schemaId":"schema_254"},{"name":"offset","in":"query","schemaId":"schema_250"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/recipients","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"status","in":"query","schemaId":"schema_257"},{"name":"search","in":"query","schemaId":"schema_258"},{"name":"limit","in":"query","schemaId":"schema_254"},{"name":"offset","in":"query","schemaId":"schema_250"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/recipients","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1recipients/get","summary":"Get all campaign recipients with status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Recipients retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}},"schemaId":"schema_259"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_259","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1recipients/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/recipients"},{"label":"Get opens timeline data (for charts)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1opens/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1opens/get","metadata":{"seo":{"title":"Get opens timeline data (for charts)","description":"Get hourly or daily breakdown of email opens for charting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get opens timeline data (for charts)","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get opens timeline data (for charts)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get hourly or daily breakdown of email opens for charting.\n\nPerfect for creating timeline charts showing when recipients opened your campaign.\n\nReturns both unique opens (distinct recipients) and total opens (includes repeat opens).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"precision","in":"query","schemaId":"schema_260","description":"Time bucket precision (hour for detailed view, day for overview)"},{"name":"filter","in":"query","schemaId":"schema_246"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/timeline/opens","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"precision","in":"query","schemaId":"schema_260"},{"name":"filter","in":"query","schemaId":"schema_246"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/timeline/opens","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1opens/get","summary":"Get opens timeline data (for charts)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Timeline data retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}},"schemaId":"schema_261"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_261","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1opens/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/timeline/opens"},{"label":"Get clicks timeline data (for charts)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1clicks/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1clicks/get","metadata":{"seo":{"title":"Get clicks timeline data (for charts)","description":"Get hourly or daily breakdown of link clicks for charting."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get clicks timeline data (for charts)","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get clicks timeline data (for charts)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get hourly or daily breakdown of link clicks for charting.\n\nPerfect for creating timeline charts showing when recipients clicked links in your campaign.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"precision","in":"query","schemaId":"schema_260"},{"name":"filter","in":"query","schemaId":"schema_246"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/timeline/clicks","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"precision","in":"query","schemaId":"schema_260"},{"name":"filter","in":"query","schemaId":"schema_246"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/timeline/clicks","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1clicks/get","summary":"Get clicks timeline data (for charts)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Timeline data retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}},"schemaId":"schema_262"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_262","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1clicks/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/timeline/clicks"},{"label":"Get link click analysis","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1links/get","routeSlug":"/customer-api.openapi/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1links/get","metadata":{"seo":{"title":"Get link click analysis","description":"Get all links clicked in the campaign with detailed click statistics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get link click analysis","isWebhook":false,"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1links/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get link click analysis","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all links clicked in the campaign with detailed click statistics.\n\nShows which links were most popular and how many unique recipients clicked each one.\n\nUseful for understanding which CTAs and content resonated with your audience.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_246"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/campaigns/{campaignId}/links","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"filter","in":"query","schemaId":"schema_246"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/campaigns/{campaignId}/links","href":"campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1links/get","summary":"Get link click analysis"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Link data retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}},"schemaId":"schema_263"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_263","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1links/get"}],"panels":[]}]},"httpPath":"/api/v1/campaigns/{campaignId}/links"}],"content":{"contentType":"group","meta":{"name":"Campaign Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign Reports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track campaign performance with comprehensive reporting and analytics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview statistics (sends, opens, clicks, bounces, rates)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact-level drill-down (who opened, who clicked)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeline charts (hourly/daily breakdowns)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link click analysis"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scanner vs human filtering for accurate metrics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Campaign Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send to Segment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/send-segment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign ID = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned from the API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends to contacts matching segment filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full campaign analytics available"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Newsletter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/bulk-send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign ID = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk_session_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID) returned from the API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both fields contain the same UUID value for campaign tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mail merge with personalized variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full campaign analytics available"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch Send"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No unified campaign tracking (individual emails)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Statistics API ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/stats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for aggregate analytics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Events API ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for individual email logs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Workflows:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"// Send to Segment Campaign\nconst { job_id } = await sendSegment({ segment_id, subject, html, from });\nconst report = await fetch(`/api/v1/campaigns/${job_id}/report?filter=human_only`);\n\n// Bulk Newsletter Campaign\nconst { campaign_id } = await bulkSend({ recipients, subject, html, from });\n// Note: bulk_session_id also available (same value as campaign_id)\nconst report = await fetch(`/api/v1/campaigns/${campaign_id}/report?filter=human_only`);\n\n// View contacts who opened\nconst openers = await fetch(`/api/v1/campaigns/${campaignId}/contacts/opened`);\n","language":"javascript"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"// Send to Segment Campaign\nconst { job_id } = await sendSegment({ segment_id, subject, html, from });\nconst report = await fetch(`/api/v1/campaigns/${job_id}/report?filter=human_only`);\n\n// Bulk Newsletter Campaign\nconst { campaign_id } = await bulkSend({ recipients, subject, html, from });\n// Note: bulk_session_id also available (same value as campaign_id)\nconst report = await fetch(`/api/v1/campaigns/${campaign_id}/report?filter=human_only`);\n\n// View contacts who opened\nconst openers = await fetch(`/api/v1/campaigns/${campaignId}/contacts/opened`);\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scanner Filtering:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Include all activity (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Exclude scanner/bot activity (recommended for metrics)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Only scanner/bot activity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track newsletter performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Measure campaign ROI"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify engaged subscribers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optimize send times with timeline data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Analyze link popularity"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/campaigns/{campaignId}/report","summary":"Get campaign overview report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1report/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/contacts/opened","summary":"Get contacts who opened","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1opened/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/contacts/clicked","summary":"Get contacts who clicked","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1clicked/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/contacts/bounced","summary":"Get contacts whose emails bounced","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1bounced/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/contacts/failed","summary":"Get contacts whose emails failed delivery","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1contacts~1failed/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/recipients","summary":"Get all campaign recipients with status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1recipients/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/timeline/opens","summary":"Get opens timeline data (for charts)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1opens/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/timeline/clicks","summary":"Get clicks timeline data (for charts)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1timeline~1clicks/get","deprecated":false},{"title":"/api/v1/campaigns/{campaignId}/links","summary":"Get link click analysis","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-reports/paths/~1api~1v1~1campaigns~1{campaignid}~1links/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Profile","link":"/customer-api.openapi/profile","routeSlug":"/customer-api.openapi/profile","items":[{"label":"Get customer profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/profile/paths/~1api~1v1~1customer~1profile/get","routeSlug":"/customer-api.openapi/profile/paths/~1api~1v1~1customer~1profile/get","metadata":{"seo":{"title":"Get customer profile","description":"Retrieve your account profile including:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get customer profile","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1profile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get customer profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve your account profile including:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current usage and remaining quota"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain limits and tracking settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key (masked for security)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor monthly email usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check available resources"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify account status"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/profile","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/customer/profile","href":"profile/paths/~1api~1v1~1customer~1profile/get","summary":"Get customer profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Profile retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_264","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1profile/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_264","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/paths/~1api~1v1~1customer~1profile/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/profile"},{"label":"Update customer profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/profile/paths/~1api~1v1~1customer~1profile/put","routeSlug":"/customer-api.openapi/profile/paths/~1api~1v1~1customer~1profile/put","metadata":{"seo":{"title":"Update customer profile","description":"Update customer profile settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update customer profile","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1profile/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update customer profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update customer profile settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Webhook endpoints are now managed via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/customer/webhooks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the Webhooks section for creating and managing multiple webhook endpoints."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_265","exampleIds":["paths/~1api~1v1~1customer~1profile/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_265","exampleIds":["paths/~1api~1v1~1customer~1profile/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1customer~1profile/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/customer/profile","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_265","exampleIds":["paths/~1api~1v1~1customer~1profile/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/customer/profile","href":"profile/paths/~1api~1v1~1customer~1profile/put","summary":"Update customer profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_265","exampleIds":["paths/~1api~1v1~1customer~1profile/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_265","exampleIds":["paths/~1api~1v1~1customer~1profile/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Profile updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1profile/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1profile/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/paths/~1api~1v1~1customer~1profile/put"}],"panels":[]}]},"httpPath":"/api/v1/customer/profile"},{"label":"Rotate API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/profile/paths/~1api~1v1~1customer~1rotate-key/post","routeSlug":"/customer-api.openapi/profile/paths/~1api~1v1~1customer~1rotate-key/post","metadata":{"seo":{"title":"Rotate API key","description":"Generate a new API key for the customer account. The old key will be immediately invalidated.Important: Update all applications with the new key immediately."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Rotate API key","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1rotate-key/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a new API key for the customer account. The old key will be immediately invalidated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Update all applications with the new key immediately."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/rotate-key","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/customer/rotate-key","href":"profile/paths/~1api~1v1~1customer~1rotate-key/post","summary":"Rotate API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"API key rotated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1rotate-key/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1rotate-key/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profile/paths/~1api~1v1~1customer~1rotate-key/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/rotate-key"}],"content":{"contentType":"group","meta":{"name":"Profile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile","showPageActions":true},{"nodeType":"markdoc","content":"Manage your customer profile, view usage limits, and rotate API keys.\nStart here to understand your account settings and available resources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customer/profile","summary":"Get customer profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/paths/~1api~1v1~1customer~1profile/get","deprecated":false},{"title":"/api/v1/customer/profile","summary":"Update customer profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/paths/~1api~1v1~1customer~1profile/put","deprecated":false},{"title":"/api/v1/customer/rotate-key","summary":"Rotate API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profile/paths/~1api~1v1~1customer~1rotate-key/post","deprecated":false}]}]}]}]}},{"type":"group","label":"SMTP","link":"/customer-api.openapi/smtp","routeSlug":"/customer-api.openapi/smtp","items":[{"type":"link","label":"Stream Type Classification via SMTP","link":"/customer-api.openapi/smtp/stream-type-classification-via-smtp","routeSlug":"/customer-api.openapi/smtp/stream-type-classification-via-smtp","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Stream Type Classification via SMTP"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"smtp/stream-type-classification-via-smtp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream Type Classification via SMTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending via SMTP, you can specify the stream type using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Stream-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Stream-Type: transactional\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Stream-Type: transactional\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Password resets, order confirmations, 2FA codes, receipts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Newsletters, marketing campaigns, bulk announcements"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - General purpose (default if not specified)"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Automatic Bulk Detection & Campaign Tracking","link":"/customer-api.openapi/smtp/automatic-bulk-detection-and-campaign-tracking","routeSlug":"/customer-api.openapi/smtp/automatic-bulk-detection-and-campaign-tracking","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Automatic Bulk Detection & Campaign Tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"smtp/automatic-bulk-detection-and-campaign-tracking"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic Bulk Detection & Campaign Tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SMTP traffic declared as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or auto-detected as bulk receives automatic campaign-level protections:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign Session Creation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Broadcast emails are grouped into campaign sessions for performance monitoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce Rate Monitoring"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Per-campaign bounce thresholds enforced (15% overall, 10% hard bounce)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-Pause Protection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Campaigns automatically paused if bounce rates exceed thresholds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISP-Specific Tracking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Monitor bounce rates per ISP (Gmail, Outlook, Yahoo, etc.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk Behavior Detection:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you send bulk-like traffic without declaring "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Stream-Type: broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system automatically detects and protects your reputation using these signals:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Volume patterns (high email count in short time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repeated subject lines (same/similar subjects to many recipients)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content/template similarity (same HTML sent repeatedly)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marketing indicators (unsubscribe headers, tracking pixels)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain concentration (many emails to same domain)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Velocity patterns (burst sending behavior)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enforcement Modes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system operates in one of four modes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-Correct (Default)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bulk-like traffic is automatically reclassified to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and receives campaign protections"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Violations logged but no enforcement applied"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strict"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bulk-like traffic declared as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rejected with clear error message"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissive"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No enforcement (not recommended for production)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why This Matters:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proper stream classification protects your sender reputation. Bulk emails sent through transactional streams can damage IP reputation and reduce deliverability for important transactional emails."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Example: PHPMailer","link":"/customer-api.openapi/smtp/example:-phpmailer","routeSlug":"/customer-api.openapi/smtp/example:-phpmailer","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Example: PHPMailer"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"smtp/example:-phpmailer"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: PHPMailer"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"use PHPMailer\\PHPMailer\\PHPMailer;\n\n$mail = new PHPMailer(true);\n$mail->isSMTP();\n$mail->Host = 'smtp.mailerlogic.net';\n$mail->SMTPAuth = true;\n$mail->Username = 'your-email@domain.com';\n$mail->Password = 'smtp_xxxxx';\n$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;\n$mail->Port = 587;\n\n// Specify stream type for IP routing\n$mail->addCustomHeader('X-Stream-Type', 'transactional');\n\n$mail->setFrom('from@domain.com', 'Sender Name');\n$mail->addAddress('recipient@example.com');\n$mail->Subject = 'Password Reset Request';\n$mail->Body = 'Click here to reset your password...';\n\n$mail->send();\n","language":"php"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"use PHPMailer\\PHPMailer\\PHPMailer;\n\n$mail = new PHPMailer(true);\n$mail->isSMTP();\n$mail->Host = 'smtp.mailerlogic.net';\n$mail->SMTPAuth = true;\n$mail->Username = 'your-email@domain.com';\n$mail->Password = 'smtp_xxxxx';\n$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;\n$mail->Port = 587;\n\n// Specify stream type for IP routing\n$mail->addCustomHeader('X-Stream-Type', 'transactional');\n\n$mail->setFrom('from@domain.com', 'Sender Name');\n$mail->addAddress('recipient@example.com');\n$mail->Subject = 'Password Reset Request';\n$mail->Body = 'Click here to reset your password...';\n\n$mail->send();\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Example: Nodemailer","link":"/customer-api.openapi/smtp/example:-nodemailer","routeSlug":"/customer-api.openapi/smtp/example:-nodemailer","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Example: Nodemailer"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"smtp/example:-nodemailer"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Nodemailer"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"const nodemailer = require('nodemailer');\n\nconst transporter = nodemailer.createTransport({\n  host: 'smtp.mailerlogic.net',\n  port: 587,\n  secure: false,\n  auth: {\n    user: 'your-email@domain.com',\n    pass: 'smtp_xxxxx'\n  }\n});\n\nawait transporter.sendMail({\n  from: 'from@domain.com',\n  to: 'recipient@example.com',\n  subject: 'Password Reset Request',\n  html: '<p>Click here to reset your password...</p>',\n  headers: {\n    'X-Stream-Type': 'transactional'\n  }\n});\n","language":"javascript"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"const nodemailer = require('nodemailer');\n\nconst transporter = nodemailer.createTransport({\n  host: 'smtp.mailerlogic.net',\n  port: 587,\n  secure: false,\n  auth: {\n    user: 'your-email@domain.com',\n    pass: 'smtp_xxxxx'\n  }\n});\n\nawait transporter.sendMail({\n  from: 'from@domain.com',\n  to: 'recipient@example.com',\n  subject: 'Password Reset Request',\n  html: '<p>Click here to reset your password...</p>',\n  headers: {\n    'X-Stream-Type': 'transactional'\n  }\n});\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"Example: Python (smtplib)","link":"/customer-api.openapi/smtp/example:-python-(smtplib)","routeSlug":"/customer-api.openapi/smtp/example:-python-(smtplib)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Example: Python (smtplib)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"smtp/example:-python-(smtplib)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Python (smtplib)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"import smtplib\nfrom email.mime.text import MIMEText\nfrom email.mime.multipart import MIMEMultipart\n\nmsg = MIMEMultipart()\nmsg['From'] = 'from@domain.com'\nmsg['To'] = 'recipient@example.com'\nmsg['Subject'] = 'Password Reset Request'\nmsg['X-Stream-Type'] = 'transactional'\n\nbody = 'Click here to reset your password...'\nmsg.attach(MIMEText(body, 'plain'))\n\nwith smtplib.SMTP('smtp.mailerlogic.net', 587) as server:\n    server.starttls()\n    server.login('your-email@domain.com', 'smtp_xxxxx')\n    server.send_message(msg)\n","language":"python"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"import smtplib\nfrom email.mime.text import MIMEText\nfrom email.mime.multipart import MIMEMultipart\n\nmsg = MIMEMultipart()\nmsg['From'] = 'from@domain.com'\nmsg['To'] = 'recipient@example.com'\nmsg['Subject'] = 'Password Reset Request'\nmsg['X-Stream-Type'] = 'transactional'\n\nbody = 'Click here to reset your password...'\nmsg.attach(MIMEText(body, 'plain'))\n\nwith smtplib.SMTP('smtp.mailerlogic.net', 587) as server:\n    server.starttls()\n    server.login('your-email@domain.com', 'smtp_xxxxx')\n    server.send_message(msg)\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always declare "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Stream-Type: broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for marketing emails, newsletters, and bulk campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Stream-Type: transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only for true 1:1 transactional messages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If unsure, omit the header or use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the system will auto-detect bulk behavior"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For high-volume campaigns, consider using the Bulk Send API ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/bulk-send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for better performance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Stream-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, emails default to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stream and may be auto-classified based on behavior."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"List SMTP credentials","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials/get","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials/get","metadata":{"seo":{"title":"List SMTP credentials","description":"Retrieve all SMTP credentials for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List SMTP credentials","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List SMTP credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all SMTP credentials for your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each credential has its own username and password. You can create multiple credentials"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for different teams, integrations, or sending domains. Restrict a credential to a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific verified sending domain so emails sent through it can only use that domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_master"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" credential is the primary credential and cannot be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/smtp-credentials","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/smtp-credentials","href":"smtp/paths/~1api~1v1~1smtp-credentials/get","summary":"List SMTP credentials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credentials retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_268"}},"schemaId":"schema_268"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_268","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_268"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials/get"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials"},{"label":"Create SMTP credential","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials/post","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials/post","metadata":{"seo":{"title":"Create SMTP credential","description":"Create a new named SMTP credential with a generated username and password."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create SMTP credential","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create SMTP credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new named SMTP credential with a generated username and password."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The plain-text password is returned only once"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response. Store it securely."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It cannot be retrieved again — use the rotate endpoint to generate a new one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally restrict the credential to a specific verified sending domain. If set,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"emails sent using this credential must use that domain in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header or they"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be rejected by the SMTP server."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hostname binding:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smtp_hostname_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to bind this credential to a specific"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom SMTP hostname. When bound, the credential can only be used to authenticate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via that hostname. A master credential ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_master: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") can authenticate via"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any hostname. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/SMTP/operation/listSMTPHostnames"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom SMTP Hostnames"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_269"}},"schemaId":"schema_269","pointer":"/paths/~1api~1v1~1smtp-credentials/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/smtp-credentials","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_269"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/smtp-credentials","href":"smtp/paths/~1api~1v1~1smtp-credentials/post","summary":"Create SMTP credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_269","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_269"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credential created — save the password now, it will not be shown again"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_270","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Validation error (e.g. domain not verified)"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_270","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/201/content/application~1json/example"]}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials/post"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials"},{"label":"Update SMTP credential","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put","metadata":{"seo":{"title":"Update SMTP credential","description":"Update the name, sending domain restriction, hostname binding, or rate limits for a credential."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update SMTP credential","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update SMTP credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the name, sending domain restriction, hostname binding, or rate limits for a credential."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credential_id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_271"}},"schemaId":"schema_271","pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/smtp-credentials/{credential_id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"credential_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_271"}},"responseCodes":["200","401","404","500"],"pointer":"/api/v1/smtp-credentials/{credential_id}","href":"smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put","summary":"Update SMTP credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_271","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_271"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credential updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}},"schemaId":"schema_272"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_272","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/{credential_id}"},{"label":"Delete SMTP credential","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete","metadata":{"seo":{"title":"Delete SMTP credential","description":"Permanently delete an SMTP credential. The credential stops working immediately."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete SMTP credential","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete SMTP credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permanently delete an SMTP credential. The credential stops working immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_master"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" credential cannot be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credential_id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/smtp-credentials/{credential_id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"credential_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/v1/smtp-credentials/{credential_id}","href":"smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete","summary":"Delete SMTP credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Credential deleted"},{"code":"400","description":"Cannot delete master credential"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/{credential_id}"},{"label":"Rotate credential password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post","metadata":{"seo":{"title":"Rotate credential password","description":"Generate a new password for a specific SMTP credential. The old password isimmediately invalidated. The new plain-text password is returned once only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Rotate credential password","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate credential password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a new password for a specific SMTP credential. The old password is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"immediately invalidated. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new plain-text password is returned once only."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credential_id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/smtp-credentials/{credential_id}/rotate","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"credential_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/smtp-credentials/{credential_id}/rotate","href":"smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post","summary":"Rotate credential password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Password rotated — save the new password now"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273"}},"schemaId":"schema_273"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_273","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/{credential_id}/rotate"},{"label":"Enable or disable a credential","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch","metadata":{"seo":{"title":"Enable or disable a credential","description":"Enable or disable a specific SMTP credential without deleting it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Enable or disable a credential","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable or disable a credential","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enable or disable a specific SMTP credential without deleting it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"credential_id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_274"}},"schemaId":"schema_274","pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/smtp-credentials/{credential_id}/status","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"credential_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_274"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/smtp-credentials/{credential_id}/status","href":"smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch","summary":"Enable or disable a credential"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_274","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_274"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Status updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}},"schemaId":"schema_272"},{"code":"400","description":"Invalid status value"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_272","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/{credential_id}/status"},{"label":"List custom SMTP hostnames","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/get","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/get","metadata":{"seo":{"title":"List custom SMTP hostnames","description":"List all white-label SMTP hostnames configured for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List custom SMTP hostnames","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom SMTP hostnames","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all white-label SMTP hostnames configured for your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom hostname (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smtp.yourdomain.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") lets your customers or integrations"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connect to MailerLogic's SMTP infrastructure using your own branded domain."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a CNAME DNS record pointing to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smtp.mailerlogic.net"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then call the verify"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint. SSL is issued automatically after DNS verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security enforcement:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Credentials are validated against the hostname they connect"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through. Only credentials whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smtp_hostname_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches the connected hostname"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(or master credentials) are accepted. Generate a dedicated credential for each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom hostname via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smtp_hostname_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From address enforcement:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If a hostname is associated with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sending_domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address in all emails must use that sending domain — not the hostname itself."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no sending domain is associated (Any / not restricted), any verified domain in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account may be used in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"From"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/smtp-credentials/hostnames","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v1/smtp-credentials/hostnames","href":"smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/get","summary":"List custom SMTP hostnames"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Hostnames retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}},"schemaId":"schema_275"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_275","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/get"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/hostnames"},{"label":"Add custom SMTP hostname","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/post","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/post","metadata":{"seo":{"title":"Add custom SMTP hostname","description":"Register a new white-label SMTP hostname."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add custom SMTP hostname","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add custom SMTP hostname","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a new white-label SMTP hostname."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After registering, add a DNS CNAME record:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"smtp.yourdomain.com  CNAME  smtp.mailerlogic.net\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"smtp.yourdomain.com  CNAME  smtp.mailerlogic.net\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Then call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /hostnames/{id}/verify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm DNS and trigger automatic SSL"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"certificate issuance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may optionally associate the hostname with a specific sending domain for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"organizational purposes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_276"}},"schemaId":"schema_276","pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/smtp-credentials/hostnames","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_276"}},"responseCodes":["201","400","401"],"pointer":"/api/v1/smtp-credentials/hostnames","href":"smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/post","summary":"Add custom SMTP hostname"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_276","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_276"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hostname registered. Next step — add the CNAME and call verify."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}},"schemaId":"schema_277"},{"code":"400","description":"Validation error"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_277","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames/post/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/post"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/hostnames"},{"label":"Remove custom SMTP hostname","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete","metadata":{"seo":{"title":"Remove custom SMTP hostname","description":"Remove custom SMTP hostname"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove custom SMTP hostname","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove custom SMTP hostname","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"hostname_id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/smtp-credentials/hostnames/{hostname_id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"hostname_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/smtp-credentials/hostnames/{hostname_id}","href":"smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete","summary":"Remove custom SMTP hostname"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Hostname removed"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/hostnames/{hostname_id}"},{"label":"Verify DNS for custom SMTP hostname","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post","metadata":{"seo":{"title":"Verify DNS for custom SMTP hostname","description":"Checks that the CNAME record for your custom hostname points tosmtp.mailerlogic.net. If verified, marks the hostname as active and triggersautomatic SSL certificate issuance via Let's Encrypt."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Verify DNS for custom SMTP hostname","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify DNS for custom SMTP hostname","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks that the CNAME record for your custom hostname points to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smtp.mailerlogic.net"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If verified, marks the hostname as active and triggers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatic SSL certificate issuance via Let's Encrypt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must set the CNAME before calling this endpoint."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" DNS propagation can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"take up to 24 hours, though it usually completes within minutes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"hostname_id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/smtp-credentials/hostnames/{hostname_id}/verify","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"hostname_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/smtp-credentials/hostnames/{hostname_id}/verify","href":"smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post","summary":"Verify DNS for custom SMTP hostname"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/pending"]}},"schemaId":"schema_278","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/pending"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_278","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/pending"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/pending"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/hostnames/{hostname_id}/verify"},{"label":"Rotate master SMTP password (legacy)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1rotate/post","routeSlug":"/customer-api.openapi/smtp/paths/~1api~1v1~1smtp-credentials~1rotate/post","metadata":{"seo":{"title":"Rotate master SMTP password (legacy)","description":"Legacy endpoint — rotates the master credential password. PreferPOST /api/v1/smtp-credentials/{credential_id}/rotate for named credentials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Rotate master SMTP password (legacy)","isWebhook":false,"pointer":"/paths/~1api~1v1~1smtp-credentials~1rotate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate master SMTP password (legacy)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy endpoint — rotates the master credential password. Prefer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/smtp-credentials/{credential_id}/rotate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for named credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/smtp-credentials/rotate","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/smtp-credentials/rotate","href":"smtp/paths/~1api~1v1~1smtp-credentials~1rotate/post","summary":"Rotate master SMTP password (legacy)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SMTP password rotated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}},"schemaId":"schema_279"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1smtp-credentials~1rotate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_279","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/smtp/paths/~1api~1v1~1smtp-credentials~1rotate/post"}],"panels":[]}]},"httpPath":"/api/v1/smtp-credentials/rotate"}],"content":{"contentType":"group","meta":{"name":"SMTP"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SMTP","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get SMTP credentials for sending emails directly through our mail servers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these endpoints to retrieve and rotate your SMTP passwords."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/smtp-credentials","summary":"List SMTP credentials","prefix":{"name":"get","color":"get"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials/get","deprecated":false},{"title":"/api/v1/smtp-credentials","summary":"Create SMTP credential","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials/post","deprecated":false},{"title":"/api/v1/smtp-credentials/{credential_id}","summary":"Update SMTP credential","prefix":{"name":"put","color":"put"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/put","deprecated":false},{"title":"/api/v1/smtp-credentials/{credential_id}","summary":"Delete SMTP credential","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete","deprecated":false},{"title":"/api/v1/smtp-credentials/{credential_id}/rotate","summary":"Rotate credential password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post","deprecated":false},{"title":"/api/v1/smtp-credentials/{credential_id}/status","summary":"Enable or disable a credential","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch","deprecated":false},{"title":"/api/v1/smtp-credentials/hostnames","summary":"List custom SMTP hostnames","prefix":{"name":"get","color":"get"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/get","deprecated":false},{"title":"/api/v1/smtp-credentials/hostnames","summary":"Add custom SMTP hostname","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames/post","deprecated":false},{"title":"/api/v1/smtp-credentials/hostnames/{hostname_id}","summary":"Remove custom SMTP hostname","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete","deprecated":false},{"title":"/api/v1/smtp-credentials/hostnames/{hostname_id}/verify","summary":"Verify DNS for custom SMTP hostname","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post","deprecated":false},{"title":"/api/v1/smtp-credentials/rotate","summary":"Rotate master SMTP password (legacy)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/smtp/paths/~1api~1v1~1smtp-credentials~1rotate/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Sending Domains","link":"/customer-api.openapi/sending-domains","routeSlug":"/customer-api.openapi/sending-domains","items":[{"label":"List all domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains/get","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains/get","metadata":{"seo":{"title":"List all domains","description":"Retrieve all domains registered to your account with their verification status. Use this to check which domains are ready for sending emails."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List all domains","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all domains registered to your account with their verification status.\nUse this to check which domains are ready for sending emails.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/domains","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/customer/domains","href":"sending-domains/paths/~1api~1v1~1customer~1domains/get","summary":"List all domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Domains retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_280","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_280","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_280","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains"},{"label":"Add domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains/post","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains/post","metadata":{"seo":{"title":"Add domain","description":"Register a new domain for sending emails. This will generate DKIM keys and DNS records.After adding, use the DNS endpoint to get records that need to be configured."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a new domain for sending emails. This will generate DKIM keys and DNS records."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After adding, use the DNS endpoint to get records that need to be configured."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new domain starts in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"security_status: pending_scan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while an automated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reputation scan runs in the background (DNS records are returned immediately —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the scan does not delay this response). Sending from the domain is soft-blocked"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and retriable until it becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"security_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_281"}},"schemaId":"schema_281","pointer":"/paths/~1api~1v1~1customer~1domains/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/domains","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_281"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/customer/domains","href":"sending-domains/paths/~1api~1v1~1customer~1domains/post","summary":"Add domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_281","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_281"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Domain created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282"}},"schemaId":"schema_282"},{"code":"400","description":"Invalid domain or limit reached","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_283"}},"schemaId":"schema_283"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_282","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_282"}}},{"code":"400","schemaId":"schema_283","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_283"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains"},{"label":"Get required DNS records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get","metadata":{"seo":{"title":"Get required DNS records","description":"Get the DNS records you need to configure for this domain. Add these TXT records to your DNS provider to verify ownership and enable email authentication (SPF, DKIM, DMARC)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get required DNS records","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get required DNS records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the DNS records you need to configure for this domain.\nAdd these TXT records to your DNS provider to verify ownership and enable email authentication (SPF, DKIM, DMARC).\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/domains/{id}/dns","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/domains/{id}/dns","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get","summary":"Get required DNS records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"DNS records retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_284","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}/dns"},{"label":"Verify domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post","metadata":{"seo":{"title":"Verify domain","description":"Verify DNS records for the domain. This checks SPF, DKIM, DMARC, and domain verification records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Verify domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verify DNS records for the domain. This checks SPF, DKIM, DMARC, and domain verification records."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/domains/{id}/verify","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/domains/{id}/verify","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post","summary":"Verify domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification completed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/success","paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"]}},"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/success","paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/success","paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_285","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/success","paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}/verify"},{"label":"Update domain tracking settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/patch","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/patch","metadata":{"seo":{"title":"Update domain tracking settings","description":"Configure per-domain tracking settings. Override global customer defaults for this specific domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update domain tracking settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update domain tracking settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure per-domain tracking settings. Override global customer defaults for this specific domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking Hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (highest to lowest priority):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-email override (in send request)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-domain settings (this endpoint)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer global defaults"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tracking_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Master toggle for all tracking (NULL = use customer default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"open_tracking_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Track email opens (NULL = use customer default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"click_tracking_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Track link clicks (NULL = use customer default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsubscribe_header_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Include List-Unsubscribe header (NULL = use customer default)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NULL Values:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to inherit from customer global settings. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to override."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox restriction:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" During the initial account review period (first 14 days for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accounts without the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tag), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"click_tracking_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value will be accepted but compliance link rewriting remains active regardless."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/customer/domains/:id/tracking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_in_sandbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rendering the setting in a UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable tracking for transactional domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable tracking only for marketing domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client-specific requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment-based (test vs production)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_all_tracking","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_opens_only","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/reset_to_defaults"]}},"schemaId":"schema_286","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_all_tracking","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_opens_only","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/reset_to_defaults"],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/customer/domains/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_all_tracking","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_opens_only","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/reset_to_defaults"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/customer/domains/{id}","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/patch","summary":"Update domain tracking settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_286","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_all_tracking","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_opens_only","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/reset_to_defaults"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_all_tracking","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_opens_only","paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/reset_to_defaults"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Domain tracking settings updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_287","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_287","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_287","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_287","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/patch"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}"},{"label":"Delete domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/delete","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/delete","metadata":{"seo":{"title":"Delete domain","description":"Remove a domain from the account. This cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a domain from the account. This cannot be undone."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/customer/domains/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/domains/{id}","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/delete","summary":"Delete domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Domain deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}},"schemaId":"schema_288"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_288","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}"},{"label":"Get domain tracking settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get","metadata":{"seo":{"title":"Get domain tracking settings","description":"Retrieve the current tracking settings for a specific domain, including per-domainoverrides, resolved account defaults, and sandbox status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get domain tracking settings","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get domain tracking settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the current tracking settings for a specific domain, including per-domain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overrides, resolved account defaults, and sandbox status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking value meanings:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Explicitly enabled for this domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Explicitly disabled for this domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Inherits from account-level default (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_defaults"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox state:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_in_sandbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the account is under initial"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"review (< 14 days old, no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tag). Click tracking is forced active for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"compliance purposes regardless of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"click_tracking_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" setting. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sandbox_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field explains this to end users."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/domains/{id}/tracking","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/domains/{id}/tracking","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get","summary":"Get domain tracking settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Domain tracking settings retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_289","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_289","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}/tracking"},{"label":"Update domain tracking settings (dedicated endpoint)","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch","metadata":{"seo":{"title":"Update domain tracking settings (dedicated endpoint)","description":"Update per-domain tracking overrides. Set any field to null to inherit from account defaults."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update domain tracking settings (dedicated endpoint)","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update domain tracking settings (dedicated endpoint)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update per-domain tracking overrides. Set any field to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to inherit from account defaults."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox restriction:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" During the initial review period ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_in_sandbox: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"click_tracking_enabled: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is silently ignored -- compliance link rewriting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remains active. Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_in_sandbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the GET endpoint before rendering the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"toggle in a UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking hierarchy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (highest to lowest priority):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-email "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"track_opens"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"track_clicks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" overrides"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-domain settings (this endpoint)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer account global defaults"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_290","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_open_tracking_only","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/reset_all_to_account_defaults","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_all_tracking"]}},"schemaId":"schema_290","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_open_tracking_only","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/reset_all_to_account_defaults","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_all_tracking"],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/customer/domains/{id}/tracking","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_290","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_open_tracking_only","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/reset_all_to_account_defaults","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_all_tracking"]}},"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/domains/{id}/tracking","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch","summary":"Update domain tracking settings (dedicated endpoint)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_290","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_open_tracking_only","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/reset_all_to_account_defaults","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_all_tracking"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_290","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_open_tracking_only","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/reset_all_to_account_defaults","paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_all_tracking"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking settings updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}/tracking"},{"label":"Check domain test readiness","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get","metadata":{"seo":{"title":"Check domain test readiness","description":"Check if a domain is ready for sending test emails and get recommendations for test mode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Check domain test readiness","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check domain test readiness","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check if a domain is ready for sending test emails and get recommendations for test mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint helps you determine the best approach for testing new domains to avoid spam filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain age and health score"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Historical sending statistics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom tracking domain status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended test mode (basic/standard/full)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warnings and actionable recommendations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Readiness checklist"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test Modes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Plain text only, no tracking, no links. Best for new domains < 7 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": HTML content with click tracking only. Best for domains 7-30 days."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All features enabled. Best for established domains > 30 days."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Case:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call this endpoint before displaying the test email form to show warnings and auto-configure tracking based on domain health."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain_id","in":"path","schemaId":"schema_245","description":"Domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/domains/test-readiness/{domain_id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"domain_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/domains/test-readiness/{domain_id}","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get","summary":"Check domain test readiness"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Domain test readiness information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_292","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_292","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/test-readiness/{domain_id}"},{"label":"Assign tracking domain to sending domain","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put","metadata":{"seo":{"title":"Assign tracking domain to sending domain","description":"Assign a specific tracking domain to a sending domain for branded click and open tracking."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Assign tracking domain to sending domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign tracking domain to sending domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign a specific tracking domain to a sending domain for branded click and open tracking."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What this does:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicitly assigns a tracking domain to a sending domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All emails from this domain will use the assigned tracking domain for links and pixels"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overrides smart matching behavior"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the tracking domain to be verified"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand consistency: Use different tracking domains for different brands"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client-specific: Assign dedicated tracking domains per client"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment separation: Different tracking for test vs production"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking domain must be verified (is_verified = true)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking domain must belong to your account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL certificate is automatically provisioned after verification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Smart Matching Fallback:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To clear an assignment and use smart matching (automatic best match), set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tracking_domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Sending domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_293","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/assign_tracking_domain","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/clear_assignment"]}},"schemaId":"schema_293","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/assign_tracking_domain","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/clear_assignment"],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/customer/domains/{id}/tracking-domain","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_293","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/assign_tracking_domain","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/clear_assignment"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/customer/domains/{id}/tracking-domain","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put","summary":"Assign tracking domain to sending domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_293","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/assign_tracking_domain","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/clear_assignment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_293","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/assign_tracking_domain","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/clear_assignment"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking domain assignment updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_294","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/assigned","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/cleared"]}},"schemaId":"schema_294","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/assigned","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/cleared"]},{"code":"400","description":"Invalid request or tracking domain not verified","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/400/content/application~1json/examples/not_verified"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/400/content/application~1json/examples/not_verified"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Domain or tracking domain not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/domain_not_found","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/tracking_not_found"]}},"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/domain_not_found","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/tracking_not_found"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_294","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/assigned","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/cleared"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_294","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/assigned","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/cleared"]}}},{"code":"400","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/400/content/application~1json/examples/not_verified"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/400/content/application~1json/examples/not_verified"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/domain_not_found","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/tracking_not_found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/domain_not_found","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/tracking_not_found"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}/tracking-domain"},{"label":"Get tracking domain assignment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get","routeSlug":"/customer-api.openapi/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get","metadata":{"seo":{"title":"Get tracking domain assignment","description":"Get the current tracking domain assignment for a sending domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get tracking domain assignment","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tracking domain assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the current tracking domain assignment for a sending domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Details:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows currently assigned tracking domain (if any)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes verification status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates assignment type (explicit or smart_matching)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignment Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"explicit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Tracking domain was manually assigned via PUT endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smart_matching"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No explicit assignment; system uses smart matching to find best tracking domain"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Sending domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/domains/{id}/tracking-domain","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/domains/{id}/tracking-domain","href":"sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get","summary":"Get tracking domain assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking domain assignment details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/explicit_assignment","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/smart_matching"]}},"schemaId":"schema_295","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/explicit_assignment","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/smart_matching"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_295","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/explicit_assignment","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/smart_matching"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/explicit_assignment","paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/smart_matching"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/domains/{id}/tracking-domain"}],"content":{"contentType":"group","meta":{"name":"Sending Domains"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sending Domains","showPageActions":true},{"nodeType":"markdoc","content":"Add and verify domains for sending authenticated emails.\nConfigure SPF, DKIM, and DMARC records to improve deliverability."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customer/domains","summary":"List all domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains/get","deprecated":false},{"title":"/api/v1/customer/domains","summary":"Add domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains/post","deprecated":false},{"title":"/api/v1/customer/domains/{id}/dns","summary":"Get required DNS records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1dns/get","deprecated":false},{"title":"/api/v1/customer/domains/{id}/verify","summary":"Verify domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1verify/post","deprecated":false},{"title":"/api/v1/customer/domains/{id}","summary":"Update domain tracking settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/patch","deprecated":false},{"title":"/api/v1/customer/domains/{id}","summary":"Delete domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}/delete","deprecated":false},{"title":"/api/v1/customer/domains/{id}/tracking","summary":"Get domain tracking settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get","deprecated":false},{"title":"/api/v1/customer/domains/{id}/tracking","summary":"Update domain tracking settings (dedicated endpoint)","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch","deprecated":false},{"title":"/api/v1/customer/domains/test-readiness/{domain_id}","summary":"Check domain test readiness","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get","deprecated":false},{"title":"/api/v1/customer/domains/{id}/tracking-domain","summary":"Assign tracking domain to sending domain","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put","deprecated":false},{"title":"/api/v1/customer/domains/{id}/tracking-domain","summary":"Get tracking domain assignment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sending-domains/paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Tracking Domains","link":"/customer-api.openapi/tracking-domains","routeSlug":"/customer-api.openapi/tracking-domains","items":[{"label":"Create tracking domain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/post","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/post","metadata":{"seo":{"title":"Create tracking domain","description":"Create a new tracking domain for your account. Tracking domains allow you to brand your click and open tracking links with your own domain instead of the default mailerlogic.net domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create tracking domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tracking domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new tracking domain for your account. Tracking domains allow you to brand your click and open tracking links with your own domain instead of the default mailerlogic.net domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What are tracking domains?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking domains are custom domains used for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click tracking URLs (when recipients click links in your emails)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open tracking pixels (when recipients open your emails)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Benefits:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Professional appearance (e.g., track.yourbrand.com instead of track.mailerlogic.net)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Improved deliverability (ISPs recognize your brand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Better email client compatibility"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setup Process:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create the tracking domain via this API"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add the CNAME record to your DNS (returned in response)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wait 5-30 minutes for DNS propagation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify the tracking domain (POST /api/v1/customer/tracking-domains/:id/verify)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL certificate is automatically provisioned after verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign tracking domain to your sending domains (PATCH /api/v1/customer/domains/:id)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/requestBody/content/application~1json/examples/basic"]}},"schemaId":"schema_296","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/requestBody/content/application~1json/examples/basic"],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/tracking-domains","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_296","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/requestBody/content/application~1json/examples/basic"]}},"responseCodes":["201","400","401","403","409","500"],"pointer":"/api/v1/customer/tracking-domains","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/post","summary":"Create tracking domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_296","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/requestBody/content/application~1json/examples/basic"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/requestBody/content/application~1json/examples/basic"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Tracking domain created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_297","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_297","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Reserved domain. The requested hostname is reserved by the platform (MailerLogic-owned domains and their subdomains) and cannot be used as a customer tracking domain. The same restriction applies when updating an existing tracking domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"},{"code":"409","description":"Domain already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_299"}},"schemaId":"schema_299"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_297","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_297","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}},{"code":"409","schemaId":"schema_299","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_299"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains"},{"label":"List tracking domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/get","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/get","metadata":{"seo":{"title":"List tracking domains","description":"Retrieve all tracking domains for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List tracking domains","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tracking domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all tracking domains for your account.\n\nReturns a list of all tracking domains with their verification and SSL status.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/tracking-domains","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/customer/tracking-domains","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/get","summary":"List tracking domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking domains retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_300","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_300","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_300","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_300","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains"},{"label":"Get tracking domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get","metadata":{"seo":{"title":"Get tracking domain","description":"Retrieve details for a specific tracking domain including DNS setup instructions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get tracking domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tracking domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details for a specific tracking domain including DNS setup instructions.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Tracking domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/tracking-domains/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/tracking-domains/{id}","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get","summary":"Get tracking domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking domain retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_301","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_301","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains/{id}"},{"label":"Update tracking domain","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch","metadata":{"seo":{"title":"Update tracking domain","description":"Update the domain name for a tracking domain. This will reset verification and SSL status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update tracking domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tracking domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the domain name for a tracking domain. This will reset verification and SSL status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Changing the domain name will require re-verification and SSL re-provisioning."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Tracking domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302"}},"schemaId":"schema_302","pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/customer/tracking-domains/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_302"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/api/v1/customer/tracking-domains/{id}","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch","summary":"Update tracking domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_302","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking domain updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_303"}},"schemaId":"schema_303"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Reserved domain. The requested hostname is reserved by the platform and cannot be used as a tracking domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"Domain already exists"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_303","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_303"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/404/content/application~1json/example"]}}},{"code":"409"},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains/{id}"},{"label":"Delete tracking domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete","metadata":{"seo":{"title":"Delete tracking domain","description":"Delete a tracking domain from your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete tracking domain","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tracking domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a tracking domain from your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You cannot delete a tracking domain that is currently assigned to any sending domains. Remove it from all sending domains first."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Tracking domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/customer/tracking-domains/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/api/v1/customer/tracking-domains/{id}","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete","summary":"Delete tracking domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking domain deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304"},{"code":"400","description":"Domain is in use","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305"}},"schemaId":"schema_305"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}}},{"code":"400","schemaId":"schema_305","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains/{id}"},{"label":"Verify tracking domain DNS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post","metadata":{"seo":{"title":"Verify tracking domain DNS","description":"Verify that the CNAME record has been correctly configured for the tracking domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Verify tracking domain DNS","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify tracking domain DNS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify that the CNAME record has been correctly configured for the tracking domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification Process:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks that the CNAME record points to the correct target"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If verified, automatically triggers SSL certificate generation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL provisioning takes 1-2 minutes after verification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After Verification:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL certificate is automatically provisioned via Let's Encrypt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check SSL status using GET /api/v1/customer/tracking-domains/:id/ssl"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tracking domain becomes ready to use once SSL is active"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Troubleshooting:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS propagation can take 5-30 minutes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dig CNAME track.yourdomain.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check DNS status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure CNAME points exactly to the target provided"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Tracking domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/tracking-domains/{id}/verify","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/tracking-domains/{id}/verify","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post","summary":"Verify tracking domain DNS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification complete","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"]}},"schemaId":"schema_306","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_306","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_306","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/verified","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains/{id}/verify"},{"label":"Check SSL certificate status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get","metadata":{"seo":{"title":"Check SSL certificate status","description":"Check the SSL certificate provisioning status for a tracking domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Check SSL certificate status","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check SSL certificate status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the SSL certificate provisioning status for a tracking domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL Certificate Lifecycle:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unavailable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Domain not yet verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provisioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certificate being generated (1-2 minutes after verification)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certificate issued and working"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certificate Details:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issued by Let's Encrypt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatically renewed before expiration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"90-day validity with auto-renewal at 60 days"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Tracking domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/tracking-domains/{id}/ssl","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/v1/customer/tracking-domains/{id}/ssl","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get","summary":"Check SSL certificate status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SSL status retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/active","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/provisioning","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/unavailable"]}},"schemaId":"schema_307","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/active","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/provisioning","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/unavailable"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_307","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/active","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/provisioning","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/active","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/provisioning","paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/unavailable"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains/{id}/ssl"},{"label":"Provision SSL certificate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post","routeSlug":"/customer-api.openapi/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post","metadata":{"seo":{"title":"Provision SSL certificate","description":"Manually trigger SSL certificate provisioning for a verified tracking domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Provision SSL certificate","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provision SSL certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually trigger SSL certificate provisioning for a verified tracking domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use this:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL was not automatically provisioned after verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You want to force certificate regeneration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous SSL provisioning failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" SSL is automatically provisioned after verification in most cases, so you typically don't need to call this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request returns immediately with 202 Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certificate generation happens in background (30-60 seconds)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check status with GET /api/v1/customer/tracking-domains/:id/ssl"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Tracking domain ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/tracking-domains/{id}/ssl","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["202","400","401","404","500"],"pointer":"/api/v1/customer/tracking-domains/{id}/ssl","href":"tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post","summary":"Provision SSL certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"SSL provisioning initiated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_308","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/202/content/application~1json/example"]},{"code":"400","description":"Domain not verified","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_308","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/tracking-domains/{id}/ssl"}],"content":{"contentType":"group","meta":{"name":"Tracking Domains"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking Domains","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage custom tracking domains for branded click and open tracking."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking domains allow you to use your own domain (e.g., track.yourdomain.com) instead of the default mailerlogic.net domain for tracking links and pixels."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setup workflow:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create tracking domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add CNAME record to DNS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify DNS configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSL automatically provisions (1-2 minutes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assign to sending domains"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customer/tracking-domains","summary":"Create tracking domain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/post","deprecated":false},{"title":"/api/v1/customer/tracking-domains","summary":"List tracking domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains/get","deprecated":false},{"title":"/api/v1/customer/tracking-domains/{id}","summary":"Get tracking domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/get","deprecated":false},{"title":"/api/v1/customer/tracking-domains/{id}","summary":"Update tracking domain","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch","deprecated":false},{"title":"/api/v1/customer/tracking-domains/{id}","summary":"Delete tracking domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete","deprecated":false},{"title":"/api/v1/customer/tracking-domains/{id}/verify","summary":"Verify tracking domain DNS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post","deprecated":false},{"title":"/api/v1/customer/tracking-domains/{id}/ssl","summary":"Check SSL certificate status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get","deprecated":false},{"title":"/api/v1/customer/tracking-domains/{id}/ssl","summary":"Provision SSL certificate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tracking-domains/paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Statistics","link":"/customer-api.openapi/statistics","routeSlug":"/customer-api.openapi/statistics","items":[{"label":"Get usage statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1customer~1usage/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1customer~1usage/get","metadata":{"seo":{"title":"Get usage statistics","description":"Retrieve current month's email usage and delivery statistics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get usage statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1usage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get usage statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve current month's email usage and delivery statistics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally filter by domain_id to get statistics for a specific sending domain."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123}],"pointer":"/paths/~1api~1v1~1customer~1usage/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/usage","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/customer/usage","href":"statistics/paths/~1api~1v1~1customer~1usage/get","summary":"Get usage statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Usage statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsageStatistics","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UsageStatistics","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1usage/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UsageStatistics","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsageStatistics","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1usage/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1customer~1usage/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/usage"},{"label":"Get outbound statistics overview","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound/get","metadata":{"seo":{"title":"Get outbound statistics overview","description":"Overview of all outbound email statistics with optional date filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get outbound statistics overview","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get outbound statistics overview","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview of all outbound email statistics with optional date filtering."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to get statistics for a specific sending domain only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence-Based Scanner Detection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to exclude bot/scanner engagement and get accurate human-only metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system now uses a confidence score (0-100) to classify engagement:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scanner"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (>= 80): Known email security systems and bots"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suspicious"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (50-79): Edge cases that may be automated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"human"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (< 50): Real user engagement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gmail and Outlook Web clicks are correctly classified as \"human\" since these clients strip referrer headers for privacy but show other human signals (residential IP, real browser UA, normal timing)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"filter","in":"query","schemaId":"schema_246","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter statistics by engagement type (NEW - Scanner Detection Feature):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): All opens/clicks including scanners"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only real human engagement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only bot/scanner engagement"},"children":[]}]}]}]}],"example":"human_only"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123}],"pointer":"/paths/~1api~1v1~1stats~1outbound/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"filter","in":"query","example":"human_only","schemaId":"schema_246"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound","href":"statistics/paths/~1api~1v1~1stats~1outbound/get","summary":"Get outbound statistics overview"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutboundStats"}},"schemaId":"components/schemas/OutboundStats"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OutboundStats","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OutboundStats"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound"},{"label":"Get send statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1sends/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1sends/get","metadata":{"seo":{"title":"Get send statistics","description":"Daily or hourly breakdown of emails sent with optional filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get send statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound~1sends/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get send statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily or hourly breakdown of emails sent with optional filtering."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter statistics for a specific sending domain."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"precision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control time granularity (day or hour)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"tag","in":"query","schemaId":"schema_258","description":"Filter by email tag","example":"newsletter"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123},{"name":"precision","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time granularity for statistics aggregation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): Daily aggregation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hourly aggregation"},"children":[]}]}]}]}],"example":"hour"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1sends/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound/sends","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"tag","in":"query","example":"newsletter","schemaId":"schema_258"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"},{"name":"precision","in":"query","example":"hour","schemaId":"schema_312"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound/sends","href":"statistics/paths/~1api~1v1~1stats~1outbound~1sends/get","summary":"Get send statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Send statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_313"}},"schemaId":"schema_313"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1sends/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_313","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_313"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1sends/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound~1sends/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound/sends"},{"label":"Get delivery statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1delivered/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1delivered/get","metadata":{"seo":{"title":"Get delivery statistics","description":"Daily or hourly breakdown of successfully delivered emails with optional filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get delivery statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound~1delivered/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get delivery statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily or hourly breakdown of successfully delivered emails with optional filtering."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows emails that were accepted by the recipient's mail server."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter statistics for a specific sending domain."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"precision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control time granularity (day or hour)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"tag","in":"query","schemaId":"schema_258","description":"Filter by email tag","example":"newsletter"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123},{"name":"precision","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time granularity for statistics aggregation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): Daily aggregation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hourly aggregation"},"children":[]}]}]}]}],"example":"hour"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1delivered/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound/delivered","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"tag","in":"query","example":"newsletter","schemaId":"schema_258"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"},{"name":"precision","in":"query","example":"hour","schemaId":"schema_312"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound/delivered","href":"statistics/paths/~1api~1v1~1stats~1outbound~1delivered/get","summary":"Get delivery statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delivery statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1delivered/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound~1delivered/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound/delivered"},{"label":"Get bounce statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1bounces/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1bounces/get","metadata":{"seo":{"title":"Get bounce statistics","description":"Daily or hourly breakdown of bounced emails with hard/soft bounce classification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get bounce statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound~1bounces/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get bounce statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily or hourly breakdown of bounced emails with hard/soft bounce classification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter statistics for a specific sending domain."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"precision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control time granularity (day or hour)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"tag","in":"query","schemaId":"schema_258","description":"Filter by email tag","example":"newsletter"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123},{"name":"precision","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time granularity for statistics aggregation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): Daily aggregation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hourly aggregation"},"children":[]}]}]}]}],"example":"hour"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1bounces/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound/bounces","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"tag","in":"query","example":"newsletter","schemaId":"schema_258"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"},{"name":"precision","in":"query","example":"hour","schemaId":"schema_312"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound/bounces","href":"statistics/paths/~1api~1v1~1stats~1outbound~1bounces/get","summary":"Get bounce statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bounce statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}},"schemaId":"schema_315"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1bounces/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_315","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound~1bounces/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound/bounces"},{"label":"Get spam complaint statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1spam/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1spam/get","metadata":{"seo":{"title":"Get spam complaint statistics","description":"Daily or hourly breakdown of spam complaints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get spam complaint statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound~1spam/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get spam complaint statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily or hourly breakdown of spam complaints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter statistics for a specific sending domain."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"precision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control time granularity (day or hour)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"tag","in":"query","schemaId":"schema_258","description":"Filter by email tag","example":"newsletter"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123},{"name":"precision","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time granularity for statistics aggregation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): Daily aggregation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hourly aggregation"},"children":[]}]}]}]}],"example":"hour"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1spam/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound/spam","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"tag","in":"query","example":"newsletter","schemaId":"schema_258"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"},{"name":"precision","in":"query","example":"hour","schemaId":"schema_312"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound/spam","href":"statistics/paths/~1api~1v1~1stats~1outbound~1spam/get","summary":"Get spam complaint statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Spam statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_316"}},"schemaId":"schema_316"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1spam/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_316","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_316"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1spam/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound~1spam/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound/spam"},{"label":"Get open statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1opens/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1opens/get","metadata":{"seo":{"title":"Get open statistics","description":"Daily or hourly breakdown of email opens (total and unique)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get open statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound~1opens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get open statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily or hourly breakdown of email opens (total and unique)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter statistics for a specific sending domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence-Based Scanner Detection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter=human_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to exclude Gmail/Apple Mail privacy protection opens and security scanner bots for accurate engagement metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens are classified using confidence scoring:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"human"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (< 50): Real user opens from Gmail, Outlook, mobile apps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suspicious"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (50-79): Apple Mail Privacy, privacy proxies, edge cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scanner"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (>= 80): Known security scanners, bots, automated systems"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"precision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control time granularity (day or hour)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"tag","in":"query","schemaId":"schema_258","description":"Filter by email tag","example":"newsletter"},{"name":"filter","in":"query","schemaId":"schema_246","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter statistics by engagement type (NEW - Scanner Detection Feature):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): All opens/clicks including scanners"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only real human engagement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only bot/scanner engagement"},"children":[]}]}]}]}],"example":"human_only"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123},{"name":"precision","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time granularity for statistics aggregation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): Daily aggregation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hourly aggregation"},"children":[]}]}]}]}],"example":"hour"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1opens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound/opens","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"tag","in":"query","example":"newsletter","schemaId":"schema_258"},{"name":"filter","in":"query","example":"human_only","schemaId":"schema_246"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"},{"name":"precision","in":"query","example":"hour","schemaId":"schema_312"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound/opens","href":"statistics/paths/~1api~1v1~1stats~1outbound~1opens/get","summary":"Get open statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Open statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}},"schemaId":"schema_317"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1opens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_317","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound~1opens/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound/opens"},{"label":"Get platform statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get","metadata":{"seo":{"title":"Get platform statistics","description":"Breakdown of email opens by email client platform (Gmail, Outlook, Apple Mail, etc.)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get platform statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get platform statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Breakdown of email opens by email client platform (Gmail, Outlook, Apple Mail, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter statistics for a specific sending domain."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound/opens/platforms","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound/opens/platforms","href":"statistics/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get","summary":"Get platform statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Platform statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_318","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_318","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound/opens/platforms"},{"label":"Get click statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1clicks/get","routeSlug":"/customer-api.openapi/statistics/paths/~1api~1v1~1stats~1outbound~1clicks/get","metadata":{"seo":{"title":"Get click statistics","description":"Daily or hourly breakdown of link clicks (total and unique)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get click statistics","isWebhook":false,"pointer":"/paths/~1api~1v1~1stats~1outbound~1clicks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get click statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily or hourly breakdown of link clicks (total and unique)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter statistics for a specific sending domain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence-Based Scanner Detection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter=human_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to exclude security scanner clicks for accurate click-through rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clicks are classified with high accuracy:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"human"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (< 50): Real clicks from Gmail, Outlook, mobile devices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suspicious"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (50-79): Fast clicks from cloud IPs with real browser UAs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scanner"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (>= 80): Proofpoint, Barracuda, Mimecast, curl, automated tools"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gmail and Outlook Web users clicking links are correctly identified as \"human\" even though these clients strip the Referer header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"precision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control time granularity (day or hour)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromdate","in":"query","schemaId":"schema_311","description":"Start date for filtering (ISO 8601)","example":"2024-03-01T00:00:00Z"},{"name":"todate","in":"query","schemaId":"schema_311","description":"End date for filtering (ISO 8601)","example":"2024-03-31T23:59:59Z"},{"name":"tag","in":"query","schemaId":"schema_258","description":"Filter by email tag","example":"newsletter"},{"name":"filter","in":"query","schemaId":"schema_246","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter statistics by engagement type (NEW - Scanner Detection Feature):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): All opens/clicks including scanners"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only real human engagement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Only bot/scanner engagement"},"children":[]}]}]}]}],"example":"human_only"},{"name":"domain_id","in":"query","schemaId":"schema_310","description":"Filter statistics by specific sending domain ID","example":123},{"name":"precision","in":"query","schemaId":"schema_312","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time granularity for statistics aggregation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default): Daily aggregation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hourly aggregation"},"children":[]}]}]}]}],"example":"hour"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1clicks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/stats/outbound/clicks","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"fromdate","in":"query","example":"2024-03-01T00:00:00Z","schemaId":"schema_311"},{"name":"todate","in":"query","example":"2024-03-31T23:59:59Z","schemaId":"schema_311"},{"name":"tag","in":"query","example":"newsletter","schemaId":"schema_258"},{"name":"filter","in":"query","example":"human_only","schemaId":"schema_246"},{"name":"domain_id","in":"query","required":false,"example":123,"schemaId":"schema_310"},{"name":"precision","in":"query","example":"hour","schemaId":"schema_312"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/v1/stats/outbound/clicks","href":"statistics/paths/~1api~1v1~1stats~1outbound~1clicks/get","summary":"Get click statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Click statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_319"}},"schemaId":"schema_319"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1stats~1outbound~1clicks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_319","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_319"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/paths/~1api~1v1~1stats~1outbound~1clicks/get"}],"panels":[]}]},"httpPath":"/api/v1/stats/outbound/clicks"}],"content":{"contentType":"group","meta":{"name":"Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statistics","showPageActions":true},{"nodeType":"markdoc","content":"Access detailed email delivery and engagement metrics.\nQuery sends, bounces, opens, clicks, and spam complaints with flexible date filters."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customer/usage","summary":"Get usage statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1customer~1usage/get","deprecated":false},{"title":"/api/v1/stats/outbound","summary":"Get outbound statistics overview","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound/get","deprecated":false},{"title":"/api/v1/stats/outbound/sends","summary":"Get send statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound~1sends/get","deprecated":false},{"title":"/api/v1/stats/outbound/delivered","summary":"Get delivery statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound~1delivered/get","deprecated":false},{"title":"/api/v1/stats/outbound/bounces","summary":"Get bounce statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound~1bounces/get","deprecated":false},{"title":"/api/v1/stats/outbound/spam","summary":"Get spam complaint statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound~1spam/get","deprecated":false},{"title":"/api/v1/stats/outbound/opens","summary":"Get open statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound~1opens/get","deprecated":false},{"title":"/api/v1/stats/outbound/opens/platforms","summary":"Get platform statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get","deprecated":false},{"title":"/api/v1/stats/outbound/clicks","summary":"Get click statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/paths/~1api~1v1~1stats~1outbound~1clicks/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Content Scoring","link":"/customer-api.openapi/content-scoring","routeSlug":"/customer-api.openapi/content-scoring","items":[{"label":"Analyze email content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/content-scoring/paths/~1api~1v1~1content-score/post","routeSlug":"/customer-api.openapi/content-scoring/paths/~1api~1v1~1content-score/post","metadata":{"seo":{"title":"Analyze email content","description":"Test your email content for spam triggers before sending.Get a deliverability score (0-100, higher is better) with specific issues and suggestions for improvement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Analyze email content","isWebhook":false,"pointer":"/paths/~1api~1v1~1content-score/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Analyze email content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test your email content for spam triggers before sending."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a deliverability score (0-100, higher is better) with specific issues and suggestions for improvement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check emails before sending campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Improve inbox placement rates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify problematic content patterns"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subject to monthly quota (default: 1000 checks/month)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"schemaId":"schema_320","pointer":"/paths/~1api~1v1~1content-score/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/content-score","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_320"}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/api/v1/content-score","href":"content-scoring/paths/~1api~1v1~1content-score/post","summary":"Analyze email content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_320","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Content analyzed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentScoreResult","exampleIds":["paths/~1api~1v1~1content-score/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ContentScoreResult","exampleIds":["paths/~1api~1v1~1content-score/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}},"schemaId":"schema_321"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}},"schemaId":"schema_322"},{"code":"403","description":"Account suspended","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"},{"code":"429","description":"Quota exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_324"}},"schemaId":"schema_324"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325"}},"schemaId":"schema_325"}],"pointer":"/paths/~1api~1v1~1content-score/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContentScoreResult","exampleIds":["paths/~1api~1v1~1content-score/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContentScoreResult","exampleIds":["paths/~1api~1v1~1content-score/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_321","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}}},{"code":"401","schemaId":"schema_322","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}}},{"code":"403","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}},{"code":"429","schemaId":"schema_324","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_324"}}},{"code":"500","schemaId":"schema_325","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/content-scoring/paths/~1api~1v1~1content-score/post"}],"panels":[]}]},"httpPath":"/api/v1/content-score"}],"content":{"contentType":"group","meta":{"name":"Content Scoring"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content Scoring","showPageActions":true},{"nodeType":"markdoc","content":"Analyze email content for spam patterns before sending.\nGet actionable feedback to improve deliverability scores."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/content-score","summary":"Analyze email content","prefix":{"name":"post","color":"post"},"badges":[],"link":"/content-scoring/paths/~1api~1v1~1content-score/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Email Validation","link":"/customer-api.openapi/email-validation","routeSlug":"/customer-api.openapi/email-validation","items":[{"label":"Validate email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate/post","routeSlug":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate/post","metadata":{"seo":{"title":"Validate email address","description":"Validate a single email address for deliverability before sending."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Validate email address","isWebhook":false,"pointer":"/paths/~1api~1v1~1address~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate email address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a single email address for deliverability before sending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comprehensive validation checks:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syntax validation (RFC 5322 compliant)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain existence verification (DNS lookup)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MX record validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced disposable email detection with continuously updated database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role account detection (support@, admin@, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP mailbox probe"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — connects to the receiving mail server and issues an RCPT TO command to confirm the individual mailbox exists (without sending a message)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catch-all domain detection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — identifies domains that accept all addresses regardless of whether the specific mailbox exists"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business benefits:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reduce bounce rates by 60-80%"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Protect your sender reputation score"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Block temporary and disposable email addresses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detect non-existent mailboxes even when the domain looks valid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify catch-all domains that can inflate your list with unknown addresses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify role accounts to improve engagement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real-time validation with instant results"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise reliability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with 99.9% uptime SLA and global infrastructure."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Consumes from your monthly validation quota (check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/address/validate/quota"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_326"}},"schemaId":"schema_326","pointer":"/paths/~1api~1v1~1address~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/address/validate","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_326"}},"responseCodes":["200","400","401","429"],"pointer":"/api/v1/address/validate","href":"email-validation/paths/~1api~1v1~1address~1validate/post","summary":"Validate email address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_326","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_326"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email validated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailValidationResult","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/valid_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_enterprise","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_unknown","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/mailbox_not_found","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/disposable_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/no_mx_records"]}},"schemaId":"components/schemas/EmailValidationResult","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/valid_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_enterprise","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_unknown","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/mailbox_not_found","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/disposable_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/no_mx_records"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/missing_email","paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/invalid_format"]}},"schemaId":"schema_327","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/missing_email","paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/invalid_format"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"429","description":"Rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/429/content/application~1json/example"]}},"schemaId":"schema_328","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/429/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1address~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailValidationResult","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/valid_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_enterprise","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_unknown","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/mailbox_not_found","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/disposable_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/no_mx_records"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailValidationResult","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/valid_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_enterprise","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_unknown","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/mailbox_not_found","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/disposable_email","paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/no_mx_records"]}}},{"code":"400","schemaId":"schema_327","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/missing_email","paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/invalid_format"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/missing_email","paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/invalid_format"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/401/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_328","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328","exampleIds":["paths/~1api~1v1~1address~1validate/post/responses/429/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-validation/paths/~1api~1v1~1address~1validate/post"}],"panels":[]}]},"httpPath":"/api/v1/address/validate"},{"label":"Validate multiple emails","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1batch/post","routeSlug":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1batch/post","metadata":{"seo":{"title":"Validate multiple emails","description":"Validate up to 1,000 unique email addresses in a single request.Each email is validated independently with full results returned, including the full intelligence layer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Validate multiple emails","isWebhook":false,"pointer":"/paths/~1api~1v1~1address~1validate~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate multiple emails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate up to 1,000 unique email addresses in a single request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each email is validated independently with full results returned, including the full intelligence layer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronous mode (default for up to 100 emails):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 100 unique emails per request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results returned directly in the response (unchanged legacy behavior)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asynchronous mode (automatic above 100 emails, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"async: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 1,000 unique emails per request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" immediately with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"job_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Emails are processed in background chunks — the request never"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hits proxy/CDN timeouts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/address/validate/batch/{jobId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch per-email results from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/address/validate/batch/{jobId}/results"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only successfully processed validations are charged against your quota"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch processing:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate emails are removed before processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each email validated independently"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consumes 1 validation credit per processed email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All results include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confidence_score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confidence_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mx_provider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_pattern"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List cleaning before campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk validation of imported contacts (CSV uploads)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-send validation of subscriber lists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prioritising sends by confidence level (send to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"very_high"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Consumes from your monthly validation quota (check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/address/validate/quota"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329","pointer":"/paths/~1api~1v1~1address~1validate~1batch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/address/validate/batch","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_329"}},"responseCodes":["200","202","400","401","429"],"pointer":"/api/v1/address/validate/batch","href":"email-validation/paths/~1api~1v1~1address~1validate~1batch/post","summary":"Validate multiple emails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch validation completed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_330","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/200/content/application~1json/example"]},{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch accepted for asynchronous processing (over 100 emails or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"async: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/202/content/application~1json/example"]}},"schemaId":"schema_331","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/202/content/application~1json/example"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/empty_array","paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/too_many"]}},"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/empty_array","paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/too_many"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"429","description":"Rate limit exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/429/content/application~1json/example"]}},"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/429/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1address~1validate~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_330","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_330","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/200/content/application~1json/example"]}}},{"code":"202","schemaId":"schema_331","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/empty_array","paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/too_many"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/empty_array","paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/too_many"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/401/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch/post/responses/429/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-validation/paths/~1api~1v1~1address~1validate~1batch/post"}],"panels":[]}]},"httpPath":"/api/v1/address/validate/batch"},{"label":"Get batch validation job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}/get","routeSlug":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}/get","metadata":{"seo":{"title":"Get batch validation job status","description":"Poll the status and progress of an asynchronous batch validation jobcreated by POST /api/v1/address/validate/batch."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get batch validation job status","isWebhook":false,"pointer":"/paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get batch validation job status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll the status and progress of an asynchronous batch validation job"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/address/validate/batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job statuses:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — job created, waiting for a worker"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — chunks are being processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — all emails processed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partial_failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — some chunks failed after retries; results for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processed emails are still available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the job could not be queued or processed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jobs are scoped to your account — you can only access your own jobs."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_245","description":"Validation job ID returned by the batch endpoint","required":true}],"pointer":"/paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/address/validate/batch/{jobId}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/address/validate/batch/{jobId}","href":"email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}/get","summary":"Get batch validation job status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Job status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_332","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_332","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}/get"}],"panels":[]}]},"httpPath":"/api/v1/address/validate/batch/{jobId}"},{"label":"Get batch validation job results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}~1results/get","routeSlug":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}~1results/get","metadata":{"seo":{"title":"Get batch validation job results","description":"Fetch paginated per-email results for an asynchronous batch validationjob. Results become available incrementally while the job is running."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get batch validation job results","isWebhook":false,"pointer":"/paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get batch validation job results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch paginated per-email results for an asynchronous batch validation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"job. Results become available incrementally while the job is running."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each result includes the same fields as the synchronous validation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_valid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validation_checks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"risk_level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverability_score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confidence_score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.) plus a summary"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"risky"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_245","description":"Validation job ID returned by the batch endpoint","required":true}],"pointer":"/paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_333","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_249","description":"Results per page"},{"name":"status","in":"query","schemaId":"schema_334","description":"Filter results by validation outcome"}],"pointer":"/paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/address/validate/batch/{jobId}/results","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"page","in":"query","schemaId":"schema_333"},{"name":"limit","in":"query","schemaId":"schema_249"},{"name":"status","in":"query","schemaId":"schema_334"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/address/validate/batch/{jobId}/results","href":"email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}~1results/get","summary":"Get batch validation job results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated job results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Job not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_231","exampleIds":["paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}~1results/get"}],"panels":[]}]},"httpPath":"/api/v1/address/validate/batch/{jobId}/results"},{"label":"Get validation quota","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1quota/get","routeSlug":"/customer-api.openapi/email-validation/paths/~1api~1v1~1address~1validate~1quota/get","metadata":{"seo":{"title":"Get validation quota","description":"Check your email validation quota usage and limits."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get validation quota","isWebhook":false,"pointer":"/paths/~1api~1v1~1address~1validate~1quota/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get validation quota","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check your email validation quota usage and limits."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quota information:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly validation limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remaining validations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor validation usage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plan batch validation operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track quota consumption"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/address/validate/quota","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/address/validate/quota","href":"email-validation/paths/~1api~1v1~1address~1validate~1quota/get","summary":"Get validation quota"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Quota information retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_336","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1address~1validate~1quota/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_336","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1address~1validate~1quota/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-validation/paths/~1api~1v1~1address~1validate~1quota/get"}],"panels":[]}]},"httpPath":"/api/v1/address/validate/quota"}],"content":{"contentType":"group","meta":{"name":"Email Validation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Validation","showPageActions":true},{"nodeType":"markdoc","content":"Enterprise email validation API to reduce bounce rates and protect sender reputation.\nReal-time validation with syntax checking, domain verification, comprehensive disposable email detection, and MX record validation.\nBuilt-in intelligence to identify role accounts and suggest corrections for common typos."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/address/validate","summary":"Validate email address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-validation/paths/~1api~1v1~1address~1validate/post","deprecated":false},{"title":"/api/v1/address/validate/batch","summary":"Validate multiple emails","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email-validation/paths/~1api~1v1~1address~1validate~1batch/post","deprecated":false},{"title":"/api/v1/address/validate/batch/{jobId}","summary":"Get batch validation job status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}/get","deprecated":false},{"title":"/api/v1/address/validate/batch/{jobId}/results","summary":"Get batch validation job results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-validation/paths/~1api~1v1~1address~1validate~1batch~1{jobid}~1results/get","deprecated":false},{"title":"/api/v1/address/validate/quota","summary":"Get validation quota","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-validation/paths/~1api~1v1~1address~1validate~1quota/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Risk Assessment","link":"/customer-api.openapi/risk-assessment","routeSlug":"/customer-api.openapi/risk-assessment","items":[{"label":"Preview risk score before sending (advisory)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/risk-assessment/paths/~1api~1v1~1risk~1preview/post","routeSlug":"/customer-api.openapi/risk-assessment/paths/~1api~1v1~1risk~1preview/post","metadata":{"seo":{"title":"Preview risk score before sending (advisory)","description":"Pre-send guidance to help you decide whether to send an email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Preview risk score before sending (advisory)","isWebhook":false,"pointer":"/paths/~1api~1v1~1risk~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview risk score before sending (advisory)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-send guidance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to help you decide whether to send an email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a risk assessment with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"would_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" boolean that indicates whether the platform will block this email if you attempt to send it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important Contract:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"advisory"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - you make the decision"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"would_block = true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will also block for the same reason"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"would_block = false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but risk is medium/high, you can still choose to send"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform may throttle/warn on high risk sends depending on your plan"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk Score Ranges:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0-29: Safe (send)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30-49: Low risk (warn)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"50-69: Medium risk (soft block - customer can override)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"70-100: High/Critical risk (hard block)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Blocks (would_block = true):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known spamtraps ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spamtrap_detected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous spam complaints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_complaint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High-confidence disposable domains > 0.85 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disposable_high_confidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender verification failure if enabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk score >= 70 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"risk_score_critical"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stable Reason Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for programmatic handling):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disposable_high_confidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Disposable domain with 90%+ confidence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disposable_medium_confidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Disposable domain with 50-89% confidence"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_not_verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - DKIM/SPF not verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spamtrap_detected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Known spamtrap address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_complaint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Recipient marked previous email as spam"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_hard_bounce"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Hard bounce on previous send"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_risk_high"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - High spam content score"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"velocity_first_send_bulk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - First send attempt is bulk email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume_spike"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unusual sending volume increase"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quota:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available on Professional and Enterprise plans"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/risk/stats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for usage and remaining quota"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337"}},"schemaId":"schema_337","pointer":"/paths/~1api~1v1~1risk~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/risk/preview","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_337"}},"responseCodes":["200","400","401","403","429"],"pointer":"/api/v1/risk/preview","href":"risk-assessment/paths/~1api~1v1~1risk~1preview/post","summary":"Preview risk score before sending (advisory)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_337","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_337"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk score calculated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/safe_send","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/medium_risk_warning","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_disposable","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_spamtrap"]}},"schemaId":"schema_338","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/safe_send","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/medium_risk_warning","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_disposable","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_spamtrap"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Feature not available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"429","description":"Quota exceeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}},"schemaId":"schema_341"}],"pointer":"/paths/~1api~1v1~1risk~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_338","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/safe_send","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/medium_risk_warning","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_disposable","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_spamtrap"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/safe_send","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/medium_risk_warning","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_disposable","paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_spamtrap"]}}},{"code":"400","schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1preview/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"429","schemaId":"schema_341","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/risk-assessment/paths/~1api~1v1~1risk~1preview/post"}],"panels":[]}]},"httpPath":"/api/v1/risk/preview"},{"label":"Get risk API usage and analytics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/risk-assessment/paths/~1api~1v1~1risk~1stats/get","routeSlug":"/customer-api.openapi/risk-assessment/paths/~1api~1v1~1risk~1stats/get","metadata":{"seo":{"title":"Get risk API usage and analytics","description":"Retrieve usage statistics, trends, and risk analytics for the Risk Score API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get risk API usage and analytics","isWebhook":false,"pointer":"/paths/~1api~1v1~1risk~1stats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get risk API usage and analytics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve usage statistics, trends, and risk analytics for the Risk Score API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information provided:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current quota (used/limit/remaining/reset_at)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Top risk factors detected in your previews"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Average risk score across all previews"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Breakdown of risk categories (recipient/content/sender/behavior)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Block rate statistics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor API quota consumption"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Understand common risk patterns in your sends"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify areas for improvement (e.g., \"30% of risk from unverified senders\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plan list cleaning or content optimization strategies"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/risk/stats","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/risk/stats","href":"risk-assessment/paths/~1api~1v1~1risk~1stats/get","summary":"Get risk API usage and analytics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_342","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1risk~1stats/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_342","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1risk~1stats/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/risk-assessment/paths/~1api~1v1~1risk~1stats/get"}],"panels":[]}]},"httpPath":"/api/v1/risk/stats"}],"content":{"contentType":"group","meta":{"name":"Risk Assessment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Risk Assessment","showPageActions":true},{"nodeType":"markdoc","content":"Pre-send risk assessment API for Professional and Enterprise plans.\nPreview risk scores before sending emails to reduce bounce rates, improve deliverability, and maintain sender reputation.\nGet detailed risk analysis with actionable recommendations and enforcement policy insights."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/risk/preview","summary":"Preview risk score before sending (advisory)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/risk-assessment/paths/~1api~1v1~1risk~1preview/post","deprecated":false},{"title":"/api/v1/risk/stats","summary":"Get risk API usage and analytics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/risk-assessment/paths/~1api~1v1~1risk~1stats/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/customer-api.openapi/events","routeSlug":"/customer-api.openapi/events","items":[{"type":"link","label":"Features","link":"/customer-api.openapi/events/features","routeSlug":"/customer-api.openapi/events/features","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Features"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"events/features"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Real human engagement detection ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_human_engagement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Bot/scanner filtering with confidence scores ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_detection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Device and browser analytics ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device_info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Complete event timeline with summary statistics"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Advanced filtering and pagination"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Data Retention","link":"/customer-api.openapi/events/data-retention","routeSlug":"/customer-api.openapi/events/data-retention","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Data Retention"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"events/data-retention"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Retention"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event data is retained based on your pricing plan:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 3 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starter Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 7 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Growth Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Professional Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 90 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 365 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only events within your plan's retention period are accessible via this API."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upgrade your plan to access longer retention periods and historical data."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Query email events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/events/paths/~1api~1v1~1events/get","routeSlug":"/customer-api.openapi/events/paths/~1api~1v1~1events/get","metadata":{"seo":{"title":"Query email events","description":"Query email events with advanced filtering and human engagement detection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Query email events","isWebhook":false,"pointer":"/paths/~1api~1v1~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query email events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query email events with advanced filtering and human engagement detection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real human engagement detection ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_human_engagement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bot/scanner filtering ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_detection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device and browser analytics ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device_info"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete event timeline with stats"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Retention:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events are retained based on your plan's data retention policy:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free: 3 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starter: 7 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Growth: 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Professional: 90 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise: 365 days"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Upgrade to a higher plan for longer retention and access to historical event data."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email_id","in":"query","schemaId":"schema_245","description":"Filter by specific email ID"},{"name":"type","in":"query","schemaId":"schema_343","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by event type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Permanent failure (hard bounce)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Temporary failure exhausted retries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferred"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently retrying"},"children":[]}]}]}]}]},{"name":"recipient","in":"query","schemaId":"schema_344","description":"Filter by recipient email (partial match)"},{"name":"from","in":"query","schemaId":"schema_344","description":"Filter by sender email (partial match)"},{"name":"from_timestamp","in":"query","schemaId":"schema_311","description":"Filter events from this timestamp"},{"name":"to_timestamp","in":"query","schemaId":"schema_311","description":"Filter events until this timestamp"},{"name":"page","in":"query","schemaId":"schema_345"},{"name":"limit","in":"query","schemaId":"schema_346"}],"pointer":"/paths/~1api~1v1~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/events","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"email_id","in":"query","schemaId":"schema_245"},{"name":"type","in":"query","schemaId":"schema_343"},{"name":"recipient","in":"query","schemaId":"schema_344"},{"name":"from","in":"query","schemaId":"schema_344"},{"name":"from_timestamp","in":"query","schemaId":"schema_311"},{"name":"to_timestamp","in":"query","schemaId":"schema_311"},{"name":"page","in":"query","schemaId":"schema_345"},{"name":"limit","in":"query","schemaId":"schema_346"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/api/v1/events","href":"events/paths/~1api~1v1~1events/get","summary":"Query email events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Events retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1events/get/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1events/get/responses/200/content/application~1json/examples/success"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Event API not enabled (Non-Enterprise Customer)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348","exampleIds":["paths/~1api~1v1~1events/get/responses/403/content/application~1json/examples/not_enabled"]}},"schemaId":"schema_348","exampleIds":["paths/~1api~1v1~1events/get/responses/403/content/application~1json/examples/not_enabled"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1events/get/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1api~1v1~1events/get/responses/200/content/application~1json/examples/success"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_348","exampleIds":["paths/~1api~1v1~1events/get/responses/403/content/application~1json/examples/not_enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348","exampleIds":["paths/~1api~1v1~1events/get/responses/403/content/application~1json/examples/not_enabled"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1events/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/paths/~1api~1v1~1events/get"}],"panels":[]}]},"httpPath":"/api/v1/events"},{"label":"Get events for specific email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/events/paths/~1api~1v1~1emails~1{email_id}~1events/get","routeSlug":"/customer-api.openapi/events/paths/~1api~1v1~1emails~1{email_id}~1events/get","metadata":{"seo":{"title":"Get events for specific email","description":"Retrieve complete event timeline for a specific email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get events for specific email","isWebhook":false,"pointer":"/paths/~1api~1v1~1emails~1{email_id}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get events for specific email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve complete event timeline for a specific email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chronological event timeline"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event summary statistics ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human engagement detection for each event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device and browser analytics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Retention:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events are only available within your plan's retention period:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free: 3 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starter: 7 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Growth: 30 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Professional: 90 days"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise: 365 days"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email_id","in":"path","schemaId":"schema_245","description":"Email ID","required":true}],"pointer":"/paths/~1api~1v1~1emails~1{email_id}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/emails/{email_id}/events","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"email_id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/v1/emails/{email_id}/events","href":"events/paths/~1api~1v1~1emails~1{email_id}~1events/get","summary":"Get events for specific email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email events retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/200/content/application~1json/examples/success"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Event API not enabled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}},"schemaId":"schema_224"},{"code":"404","description":"Email not found or access denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1emails~1{email_id}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/200/content/application~1json/examples/success"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_224","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}}},{"code":"404","schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/paths/~1api~1v1~1emails~1{email_id}~1events/get"}],"panels":[]}]},"httpPath":"/api/v1/emails/{email_id}/events"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query email lifecycle events with human engagement detection and device analytics."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/events","summary":"Query email events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/paths/~1api~1v1~1events/get","deprecated":false},{"title":"/api/v1/emails/{email_id}/events","summary":"Get events for specific email","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/paths/~1api~1v1~1emails~1{email_id}~1events/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Bounces","link":"/customer-api.openapi/bounces","routeSlug":"/customer-api.openapi/bounces","items":[{"label":"List bounce events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/bounces/paths/~1api~1customer~1bounces/get","routeSlug":"/customer-api.openapi/bounces/paths/~1api~1customer~1bounces/get","metadata":{"seo":{"title":"List bounce events","description":"Get detailed bounce event history with SMTP diagnostic codes and error messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List bounce events","isWebhook":false,"pointer":"/paths/~1api~1customer~1bounces/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List bounce events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get detailed bounce event history with SMTP diagnostic codes and error messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounces vs Suppressions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounces endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Shows complete history of ALL bounce events with diagnostic details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppressions endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Shows currently blocked addresses (no diagnostic codes)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View exact SMTP error codes (550 5.1.1, 452 4.2.2, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Analyze bounce rate trends over time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debug delivery issues with detailed error messages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track bounce patterns for specific recipients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate bounce analytics and reports"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Permanent delivery failure (invalid address, domain doesn't exist)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Temporary failure (mailbox full, server down)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complaint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient marked email as spam"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient's server blocked delivery"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common SMTP Status Codes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"550 5.1.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User unknown / Mailbox doesn't exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"552 5.2.2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mailbox full"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"553 5.3.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Domain doesn't exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"554 5.7.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Blocked by recipient server"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"452 4.2.2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mailbox full (temporary)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All hard bounces are automatically added to your suppressions list."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_311","description":"Filter bounces from this date (ISO 8601 format)","example":"2026-01-01T00:00:00Z"},{"name":"to","in":"query","schemaId":"schema_311","description":"Filter bounces to this date (ISO 8601 format)","example":"2026-02-26T23:59:59Z"},{"name":"type","in":"query","schemaId":"schema_351","description":"Filter by bounce type"},{"name":"recipient","in":"query","schemaId":"schema_344","description":"Filter by recipient email address","example":"user@example.com"},{"name":"limit","in":"query","schemaId":"schema_352","description":"Number of results to return"},{"name":"offset","in":"query","schemaId":"schema_353","description":"Pagination offset"}],"pointer":"/paths/~1api~1customer~1bounces/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customer/bounces","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","example":"2026-01-01T00:00:00Z","schemaId":"schema_311"},{"name":"to","in":"query","example":"2026-02-26T23:59:59Z","schemaId":"schema_311"},{"name":"type","in":"query","schemaId":"schema_351"},{"name":"recipient","in":"query","example":"user@example.com","schemaId":"schema_344"},{"name":"limit","in":"query","schemaId":"schema_352"},{"name":"offset","in":"query","schemaId":"schema_353"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/customer/bounces","href":"bounces/paths/~1api~1customer~1bounces/get","summary":"List bounce events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bounce events retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354","exampleIds":["paths/~1api~1customer~1bounces/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_354","exampleIds":["paths/~1api~1customer~1bounces/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1customer~1bounces/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_354","exampleIds":["paths/~1api~1customer~1bounces/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354","exampleIds":["paths/~1api~1customer~1bounces/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1bounces/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bounces/paths/~1api~1customer~1bounces/get"}],"panels":[]}]},"httpPath":"/api/customer/bounces"}],"content":{"contentType":"group","meta":{"name":"Bounces"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bounces","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View detailed bounce event history with SMTP diagnostic codes and error messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What's the Difference?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Complete historical log of every bounce event with diagnostic details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppressions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Current list of blocked addresses (includes bounces, complaints, manual blocks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": User preference opt-outs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bounce"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Permanent delivery failure (invalid address, domain doesn't exist)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft Bounce"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Temporary failure (mailbox full, server down)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient marked email as spam"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Block"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Recipient's server blocked delivery (reputation, content filters)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View why a specific email bounced (SMTP diagnostic codes)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Analyze bounce rate trends over time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debug delivery issues with detailed error messages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit trail for compliance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track bounce patterns for a recipient"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP Diagnostic Codes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"550 5.1.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - User unknown / Mailbox doesn't exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"552 5.2.2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Mailbox full"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"553 5.3.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Domain doesn't exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"554 5.7.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Blocked by recipient server"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic Actions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard bounces are automatically added to suppressions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft bounces are tracked; repeated soft bounces become suppressions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All bounce events are logged for analytics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike suppressions (which show only currently blocked addresses), the bounces endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provides complete diagnostic information for every bounce that occurred."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customer/bounces","summary":"List bounce events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bounces/paths/~1api~1customer~1bounces/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Suppressions","link":"/customer-api.openapi/suppressions","routeSlug":"/customer-api.openapi/suppressions","items":[{"label":"List all suppressions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/suppressions/paths/~1api~1customer~1suppressions/get","routeSlug":"/customer-api.openapi/suppressions/paths/~1api~1customer~1suppressions/get","metadata":{"seo":{"title":"List all suppressions","description":"Retrieve all system-managed suppressions (hard bounces, soft bounces, and spam complaints) with filtering capabilities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List all suppressions","isWebhook":false,"pointer":"/paths/~1api~1customer~1suppressions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all suppressions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all system-managed suppressions (hard bounces, soft bounces, and spam complaints) with filtering capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor bounce and complaint trends"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export comprehensive suppression lists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by type, domain, or date range"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track suppression sources and reasons"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage whitelist overrides"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppression Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounce"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hard and soft bounces (added automatically by the system)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complaint"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Spam complaints and feedback loop reports (added automatically)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each suppression includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicating whether it's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (all domains) or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For user opt-outs and unsubscribes, see the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/customer/unsubscribes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_345"},{"name":"limit","in":"query","schemaId":"schema_346"},{"name":"search","in":"query","schemaId":"schema_258","description":"Search by email address (partial match)"},{"name":"type","in":"query","schemaId":"schema_355","description":"Filter by suppression type"},{"name":"domain_id","in":"query","schemaId":"schema_245","description":"Filter by specific domain"},{"name":"from_date","in":"query","schemaId":"schema_356","description":"Filter from date (YYYY-MM-DD)"},{"name":"to_date","in":"query","schemaId":"schema_356","description":"Filter to date (YYYY-MM-DD)"}],"pointer":"/paths/~1api~1customer~1suppressions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customer/suppressions","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_345"},{"name":"limit","in":"query","schemaId":"schema_346"},{"name":"search","in":"query","schemaId":"schema_258"},{"name":"type","in":"query","schemaId":"schema_355"},{"name":"domain_id","in":"query","schemaId":"schema_245"},{"name":"from_date","in":"query","schemaId":"schema_356"},{"name":"to_date","in":"query","schemaId":"schema_356"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/customer/suppressions","href":"suppressions/paths/~1api~1customer~1suppressions/get","summary":"List all suppressions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Suppressions retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_357","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1customer~1suppressions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_357","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suppressions/paths/~1api~1customer~1suppressions/get"}],"panels":[]}]},"httpPath":"/api/customer/suppressions"},{"label":"Add suppression","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/suppressions/paths/~1api~1customer~1suppressions/post","routeSlug":"/customer-api.openapi/suppressions/paths/~1api~1customer~1suppressions/post","metadata":{"seo":{"title":"Add suppression","description":"Manually add an email to your suppression list for bounces or spam complaints."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add suppression","isWebhook":false,"pointer":"/paths/~1api~1customer~1suppressions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add suppression","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually add an email to your suppression list for bounces or spam complaints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppression Scope:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to suppress across ALL your domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to suppress for a specific domain only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual bounce additions for known bad addresses"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding complaint addresses from external feedback loops"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proactive list cleaning based on email validation results"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Importing suppressions from other platforms"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For managing user opt-outs, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/customer/unsubscribes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358","pointer":"/paths/~1api~1customer~1suppressions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customer/suppressions","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_358"}},"responseCodes":["201","400","401","409"],"pointer":"/api/customer/suppressions","href":"suppressions/paths/~1api~1customer~1suppressions/post","summary":"Add suppression"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Suppression added successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"Email already suppressed"}],"pointer":"/paths/~1api~1customer~1suppressions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions/post/responses/401/content/application~1json/example"]}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suppressions/paths/~1api~1customer~1suppressions/post"}],"panels":[]}]},"httpPath":"/api/customer/suppressions"},{"label":"Remove suppression","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/suppressions/paths/~1api~1customer~1suppressions~1{suppressionid}/delete","routeSlug":"/customer-api.openapi/suppressions/paths/~1api~1customer~1suppressions~1{suppressionid}/delete","metadata":{"seo":{"title":"Remove suppression","description":"Remove an email from your suppression list by suppression ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove suppression","isWebhook":false,"pointer":"/paths/~1api~1customer~1suppressions~1{suppressionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove suppression","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove an email from your suppression list by suppression ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only remove suppressions if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient has explicitly requested re-subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have verified the email address is valid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For bounces: You have confirmed the email is now deliverable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For complaints: You have received explicit consent to resume sending"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"suppressionId","in":"path","schemaId":"schema_245","description":"Suppression ID to remove","required":true}],"pointer":"/paths/~1api~1customer~1suppressions~1{suppressionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/customer/suppressions/{suppressionId}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"suppressionId","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/customer/suppressions/{suppressionId}","href":"suppressions/paths/~1api~1customer~1suppressions~1{suppressionid}/delete","summary":"Remove suppression"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Suppression removed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/suppressions/paths/~1api~1customer~1suppressions~1{suppressionid}/delete"}],"panels":[]}]},"httpPath":"/api/customer/suppressions/{suppressionId}"}],"content":{"contentType":"group","meta":{"name":"Suppressions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Suppressions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage system-level suppressions for bounces and spam complaints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppression Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hard Bounces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Permanent delivery failures (automatically added by the system)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft Bounces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Temporary delivery failures (automatically added after threshold)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaints"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Spam complaints and feedback loop reports"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppression Scope:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Applies to ALL your domains (when no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Applies to a specific domain only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic bounce and complaint handling"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whitelist management to override suppressions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all suppressions with filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual suppression management"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated list hygiene to protect your sender reputation and ensure compliance."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customer/suppressions","summary":"List all suppressions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/suppressions/paths/~1api~1customer~1suppressions/get","deprecated":false},{"title":"/api/customer/suppressions","summary":"Add suppression","prefix":{"name":"post","color":"post"},"badges":[],"link":"/suppressions/paths/~1api~1customer~1suppressions/post","deprecated":false},{"title":"/api/customer/suppressions/{suppressionId}","summary":"Remove suppression","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/suppressions/paths/~1api~1customer~1suppressions~1{suppressionid}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Unsubscribes","link":"/customer-api.openapi/unsubscribes","routeSlug":"/customer-api.openapi/unsubscribes","items":[{"label":"List unsubscribes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes/get","routeSlug":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes/get","metadata":{"seo":{"title":"List unsubscribes","description":"Retrieve your unsubscribe list with filtering and search capabilities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List unsubscribes","isWebhook":false,"pointer":"/paths/~1api~1customer~1unsubscribes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List unsubscribes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve your unsubscribe list with filtering and search capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor user opt-out trends"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export unsubscribe lists for compliance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit unsubscribe sources (API, link clicks, manual)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by domain or view all unsubscribes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track consent management across your domains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete unsubscribe lifecycle management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with comprehensive analytics and compliance reporting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each unsubscribe includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicating whether it's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (all domains) or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For system-managed suppressions (bounces, complaints), see the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/customer/suppressions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_345"},{"name":"limit","in":"query","schemaId":"schema_346"},{"name":"search","in":"query","schemaId":"schema_258","description":"Search by email address (partial match)"},{"name":"domain_id","in":"query","schemaId":"schema_245","description":"Filter by specific domain (omit to see all unsubscribes)"},{"name":"from_date","in":"query","schemaId":"schema_356","description":"Filter from date (YYYY-MM-DD)"},{"name":"to_date","in":"query","schemaId":"schema_356","description":"Filter to date (YYYY-MM-DD)"}],"pointer":"/paths/~1api~1customer~1unsubscribes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customer/unsubscribes","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_345"},{"name":"limit","in":"query","schemaId":"schema_346"},{"name":"search","in":"query","schemaId":"schema_258"},{"name":"domain_id","in":"query","schemaId":"schema_245"},{"name":"from_date","in":"query","schemaId":"schema_356"},{"name":"to_date","in":"query","schemaId":"schema_356"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/customer/unsubscribes","href":"unsubscribes/paths/~1api~1customer~1unsubscribes/get","summary":"List unsubscribes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Unsubscribes retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_361","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/500/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1customer~1unsubscribes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_361","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribes/paths/~1api~1customer~1unsubscribes/get"}],"panels":[]}]},"httpPath":"/api/customer/unsubscribes"},{"label":"Add to unsubscribe list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes/post","routeSlug":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes/post","metadata":{"seo":{"title":"Add to unsubscribe list","description":"Add an email address to your unsubscribe list for user consent management."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add to unsubscribe list","isWebhook":false,"pointer":"/paths/~1api~1customer~1unsubscribes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add to unsubscribe list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add an email address to your unsubscribe list for user consent management."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribe Scope:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unsubscribe from ALL your domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unsubscribe from a specific domain only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing manual unsubscribe requests (phone, email, support tickets)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Honoring opt-out preferences from other channels"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Importing unsubscribe lists from other platforms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific opt-outs for users who want targeted unsubscribes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proactive consent management"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unsubscribe links in emails are handled automatically. Use this endpoint for opt-outs from other channels."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362","pointer":"/paths/~1api~1customer~1unsubscribes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customer/unsubscribes","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_362"}},"responseCodes":["201","400","401","409"],"pointer":"/api/customer/unsubscribes","href":"unsubscribes/paths/~1api~1customer~1unsubscribes/post","summary":"Add to unsubscribe list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_362"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Email unsubscribed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"Email already unsubscribed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365"}],"pointer":"/paths/~1api~1customer~1unsubscribes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}},{"code":"400","schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes/post/responses/401/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribes/paths/~1api~1customer~1unsubscribes/post"}],"panels":[]}]},"httpPath":"/api/customer/unsubscribes"},{"label":"Bulk import unsubscribes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes~1import/post","routeSlug":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes~1import/post","metadata":{"seo":{"title":"Bulk import unsubscribes","description":"Import multiple email addresses into your unsubscribe list in one request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Bulk import unsubscribes","isWebhook":false,"pointer":"/paths/~1api~1customer~1unsubscribes~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk import unsubscribes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import multiple email addresses into your unsubscribe list in one request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribe Scope:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unsubscribe from ALL your domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to unsubscribe from a specific domain only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate emails in the request and emails that are already unsubscribed are counted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid email addresses are counted as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","pointer":"/paths/~1api~1customer~1unsubscribes~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customer/unsubscribes/import","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_366"}},"responseCodes":["201","400","401"],"pointer":"/api/customer/unsubscribes/import","href":"unsubscribes/paths/~1api~1customer~1unsubscribes~1import/post","summary":"Bulk import unsubscribes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_366"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Unsubscribe import completed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367"},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}},"schemaId":"schema_224"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1import/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1import/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1customer~1unsubscribes~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}}},{"code":"400","schemaId":"schema_224","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_224"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1import/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1import/post/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribes/paths/~1api~1customer~1unsubscribes~1import/post"}],"panels":[]}]},"httpPath":"/api/customer/unsubscribes/import"},{"label":"Re-subscribe email","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes~1{email}/delete","routeSlug":"/customer-api.openapi/unsubscribes/paths/~1api~1customer~1unsubscribes~1{email}/delete","metadata":{"seo":{"title":"Re-subscribe email","description":"Remove an email from your unsubscribe list, allowing them to receive emails again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Re-subscribe email","isWebhook":false,"pointer":"/paths/~1api~1customer~1unsubscribes~1{email}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Re-subscribe email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove an email from your unsubscribe list, allowing them to receive emails again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-subscribe Scope:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query param to remove from global unsubscribe list"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query param to remove domain-specific unsubscribe"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only do this when:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient has explicitly requested to be re-subscribed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have documented proof of their consent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You comply with applicable consent regulations (GDPR, CAN-SPAM, etc.)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processing re-subscription requests from users"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Honoring preference center updates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correcting accidental unsubscribes"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_344","description":"Email address to re-subscribe (URL encoded)","required":true}],"pointer":"/paths/~1api~1customer~1unsubscribes~1{email}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domain_id","in":"query","schemaId":"schema_245","description":"Optional - Specify domain ID to remove domain-specific unsubscribe. Omit to remove global unsubscribe."}],"pointer":"/paths/~1api~1customer~1unsubscribes~1{email}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/customer/unsubscribes/{email}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_344"}],"query":[{"name":"domain_id","in":"query","required":false,"schemaId":"schema_245"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/customer/unsubscribes/{email}","href":"unsubscribes/paths/~1api~1customer~1unsubscribes~1{email}/delete","summary":"Re-subscribe email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email re-subscribed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1{email}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1{email}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Email not found in unsubscribe list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369"}],"pointer":"/paths/~1api~1customer~1unsubscribes~1{email}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1{email}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1unsubscribes~1{email}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unsubscribes/paths/~1api~1customer~1unsubscribes~1{email}/delete"}],"panels":[]}]},"httpPath":"/api/customer/unsubscribes/{email}"}],"content":{"contentType":"group","meta":{"name":"Unsubscribes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unsubscribes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage user consent and opt-out preferences."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding Unsubscribe Links to Emails:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder in your email HTML or text:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>\n","language":"html"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic automatically:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a unique, secure URL per recipient"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds RFC 8058 List-Unsubscribe headers for Gmail/Outlook one-click"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracks unsubscribes per domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enforces unsubscribe preferences on future sends"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-Initiated Opt-Outs:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribe link clicks in emails (via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-click unsubscribe in email clients (Gmail, Outlook)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API-based unsubscribe requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific or global unsubscribe preferences"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unsubscribe Scope:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": User opts out from ALL your domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": User opts out from a specific domain only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add emails to unsubscribe list"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove (re-subscribe) emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all unsubscribed emails with filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic enforcement during email sending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensures compliance with CAN-SPAM, GDPR, and other anti-spam regulations."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customer/unsubscribes","summary":"List unsubscribes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/unsubscribes/paths/~1api~1customer~1unsubscribes/get","deprecated":false},{"title":"/api/customer/unsubscribes","summary":"Add to unsubscribe list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unsubscribes/paths/~1api~1customer~1unsubscribes/post","deprecated":false},{"title":"/api/customer/unsubscribes/import","summary":"Bulk import unsubscribes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unsubscribes/paths/~1api~1customer~1unsubscribes~1import/post","deprecated":false},{"title":"/api/customer/unsubscribes/{email}","summary":"Re-subscribe email","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/unsubscribes/paths/~1api~1customer~1unsubscribes~1{email}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Health Score","link":"/customer-api.openapi/health-score","routeSlug":"/customer-api.openapi/health-score","items":[{"label":"Get health score","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/health-score/paths/~1api~1customer~1health-score/get","routeSlug":"/customer-api.openapi/health-score/paths/~1api~1customer~1health-score/get","metadata":{"seo":{"title":"Get health score","description":"Retrieve your account's email health score and engagement quality metrics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get health score","isWebhook":false,"pointer":"/paths/~1api~1customer~1health-score/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get health score","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve your account's email health score and engagement quality metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health Score (0-100)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates your overall sending reputation based on:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Engagement (opens/clicks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce rate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaint rate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reputation Grades:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A+ (95-100): Outstanding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A (90-94): Excellent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B+ (85-89): Good"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"B (80-84): Above average"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C+ (75-79): Fair"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C (70-74): Below average"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"D (60-69): Poor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F (0-59): Critical"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customer/health-score","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/customer/health-score","href":"health-score/paths/~1api~1customer~1health-score/get","summary":"Get health score"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Health score retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/global","paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/domain_specific"]}},"schemaId":"schema_370","exampleIds":["paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/global","paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/domain_specific"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"No data available yet","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371"}},"schemaId":"schema_371"}],"pointer":"/paths/~1api~1customer~1health-score/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_370","exampleIds":["paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/global","paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/domain_specific"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/global","paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/domain_specific"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health-score/paths/~1api~1customer~1health-score/get"}],"panels":[]}]},"httpPath":"/api/customer/health-score"},{"label":"Get health score history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/health-score/paths/~1api~1customer~1health-score~1history/get","routeSlug":"/customer-api.openapi/health-score/paths/~1api~1customer~1health-score~1history/get","metadata":{"seo":{"title":"Get health score history","description":"Retrieve historical health score data over time. Use this to track trends and improvements in your sending reputation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get health score history","isWebhook":false,"pointer":"/paths/~1api~1customer~1health-score~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get health score history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve historical health score data over time.\nUse this to track trends and improvements in your sending reputation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_372","description":"Number of days of history to retrieve"}],"pointer":"/paths/~1api~1customer~1health-score~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/customer/health-score/history","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"days","in":"query","schemaId":"schema_372"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/customer/health-score/history","href":"health-score/paths/~1api~1customer~1health-score~1history/get","summary":"Get health score history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"History retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_373","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1customer~1health-score~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_373","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1history/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health-score/paths/~1api~1customer~1health-score~1history/get"}],"panels":[]}]},"httpPath":"/api/customer/health-score/history"},{"label":"Refresh health score","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/health-score/paths/~1api~1customer~1health-score~1refresh/post","routeSlug":"/customer-api.openapi/health-score/paths/~1api~1customer~1health-score~1refresh/post","metadata":{"seo":{"title":"Refresh health score","description":"Recalculate your health score with the latest data. Health scores are automatically updated daily, but you can manually refresh when needed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Refresh health score","isWebhook":false,"pointer":"/paths/~1api~1customer~1health-score~1refresh/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh health score","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Recalculate your health score with the latest data.\nHealth scores are automatically updated daily, but you can manually refresh when needed.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/customer/health-score/refresh","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/customer/health-score/refresh","href":"health-score/paths/~1api~1customer~1health-score~1refresh/post","summary":"Refresh health score"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Health score refreshed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1refresh/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1refresh/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"No data available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375"}],"pointer":"/paths/~1api~1customer~1health-score~1refresh/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1refresh/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1customer~1health-score~1refresh/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health-score/paths/~1api~1customer~1health-score~1refresh/post"}],"panels":[]}]},"httpPath":"/api/customer/health-score/refresh"}],"content":{"contentType":"group","meta":{"name":"Health Score"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health Score","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor your account's email health and engagement quality metrics."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a 0-100 score with reputation grade (A+ to F) and actionable insights."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/customer/health-score","summary":"Get health score","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health-score/paths/~1api~1customer~1health-score/get","deprecated":false},{"title":"/api/customer/health-score/history","summary":"Get health score history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health-score/paths/~1api~1customer~1health-score~1history/get","deprecated":false},{"title":"/api/customer/health-score/refresh","summary":"Refresh health score","prefix":{"name":"post","color":"post"},"badges":[],"link":"/health-score/paths/~1api~1customer~1health-score~1refresh/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Tracking","link":"/customer-api.openapi/tracking","routeSlug":"/customer-api.openapi/tracking","items":[{"label":"Track email open","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking/paths/~1track~1o~1{token}/get","routeSlug":"/customer-api.openapi/tracking/paths/~1track~1o~1{token}/get","metadata":{"seo":{"title":"Track email open","description":"Open tracking pixel endpoint. Returns a 1x1 transparent GIF."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Track email open","isWebhook":false,"pointer":"/paths/~1track~1o~1{token}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Track email open","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open tracking pixel endpoint. Returns a 1x1 transparent GIF."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you enable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"track_opens: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your email send request, MailerLogic automatically injects a tracking pixel into the HTML body"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pixel contains a unique encrypted token specific to that email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the recipient opens the email, their email client loads the pixel, triggering this endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The open event is recorded and available via the Events API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public endpoint - no authentication required."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The token provides the necessary context."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_258","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted tracking token automatically generated and embedded by MailerLogic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains email_id and recipient information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You do not need to generate this token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - it is created automatically when sending emails with tracking enabled."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1track~1o~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/track/o/{token}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_258"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/track/o/{token}","href":"tracking/paths/~1track~1o~1{token}/get","summary":"Track email open"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tracking pixel returned","mediaType":"image/gif","mediaTypes":["image/gif"],"mediaTypeContent":{"image/gif":{"schemaId":"schema_376"}},"schemaId":"schema_376"}],"pointer":"/paths/~1track~1o~1{token}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_376","mediaTypes":["image/gif"],"mediaTypeContent":{"image/gif":{"schemaId":"schema_376"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking/paths/~1track~1o~1{token}/get"}],"panels":[]}]},"httpPath":"/track/o/{token}"},{"label":"Track link click","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking/paths/~1track~1c~1{token}/get","routeSlug":"/customer-api.openapi/tracking/paths/~1track~1c~1{token}/get","metadata":{"seo":{"title":"Track link click","description":"Click tracking redirect endpoint. Logs the click and redirects to the original URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Track link click","isWebhook":false,"pointer":"/paths/~1track~1c~1{token}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Track link click","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click tracking redirect endpoint. Logs the click and redirects to the original URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you enable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"track_clicks: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your email send request, MailerLogic automatically rewrites all links in your HTML"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each link is replaced with a tracking URL containing a unique encrypted token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the recipient clicks a link, they are redirected through this endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The click event is recorded and the user is immediately redirected to the original destination"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public endpoint - no authentication required."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The token provides the necessary context."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_258","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted tracking token automatically generated and embedded by MailerLogic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains email_id and the original destination URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You do not need to generate this token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - it is created automatically when sending emails with tracking enabled."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1track~1c~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/track/c/{token}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_258"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302"],"pointer":"/track/c/{token}","href":"tracking/paths/~1track~1c~1{token}/get","summary":"Track link click"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect to target URL","headers":{"Location":{"schema":{"type":"string","format":"uri"},"description":"Original URL from the email"}},"headerSchemaId":"schema_377"}],"pointer":"/paths/~1track~1c~1{token}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking/paths/~1track~1c~1{token}/get"}],"panels":[]}]},"httpPath":"/track/c/{token}"},{"label":"Unsubscribe (manual)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking/paths/~1track~1u~1{token}/get","routeSlug":"/customer-api.openapi/tracking/paths/~1track~1u~1{token}/get","metadata":{"seo":{"title":"Unsubscribe (manual)","description":"Manual unsubscribe endpoint. Shows a confirmation page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Unsubscribe (manual)","isWebhook":false,"pointer":"/paths/~1track~1u~1{token}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unsubscribe (manual)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual unsubscribe endpoint. Shows a confirmation page."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When you include an unsubscribe link in your emails, MailerLogic can automatically generate an encrypted token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient clicks the unsubscribe link in their email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are taken to a confirmation page where they can confirm their unsubscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public endpoint - no authentication required."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The token provides the necessary context."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_258","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted unsubscribe token automatically generated by MailerLogic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains email_id and recipient information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You do not need to generate this token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - it is created automatically by the system."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1track~1u~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/track/u/{token}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_258"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/track/u/{token}","href":"tracking/paths/~1track~1u~1{token}/get","summary":"Unsubscribe (manual)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Unsubscribe confirmation page","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_258"}},"schemaId":"schema_258"},{"code":"400","description":"Invalid or expired token","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_258"}},"schemaId":"schema_258"}],"pointer":"/paths/~1track~1u~1{token}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_258","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_258"}}},{"code":"400","schemaId":"schema_258","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_258"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking/paths/~1track~1u~1{token}/get"}],"panels":[]}]},"httpPath":"/track/u/{token}"},{"label":"One-click unsubscribe (RFC 8058)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tracking/paths/~1track~1u~1{token}/post","routeSlug":"/customer-api.openapi/tracking/paths/~1track~1u~1{token}/post","metadata":{"seo":{"title":"One-click unsubscribe (RFC 8058)","description":"One-click unsubscribe endpoint per RFC 8058.Email clients can call this to instantly unsubscribe users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"One-click unsubscribe (RFC 8058)","isWebhook":false,"pointer":"/paths/~1track~1u~1{token}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"One-click unsubscribe (RFC 8058)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-click unsubscribe endpoint per RFC 8058."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email clients can call this to instantly unsubscribe users."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic automatically adds the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List-Unsubscribe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List-Unsubscribe-Post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers to your emails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Major email clients (Gmail, Yahoo, etc.) display an \"Unsubscribe\" button"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When clicked, the email client POSTs to this endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user is instantly unsubscribed without visiting a webpage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public endpoint - no authentication required."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The token provides the necessary context."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_258","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encrypted unsubscribe token automatically generated by MailerLogic."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains email_id and recipient information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You do not need to generate this token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - it is created automatically by the system."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1track~1u~1{token}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/track/u/{token}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_258"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/track/u/{token}","href":"tracking/paths/~1track~1u~1{token}/post","summary":"One-click unsubscribe (RFC 8058)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Unsubscribed successfully","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_378"}},"schemaId":"schema_378"},{"code":"400","description":"Invalid token","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_379"}},"schemaId":"schema_379"}],"pointer":"/paths/~1track~1u~1{token}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_378","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_378"}}},{"code":"400","schemaId":"schema_379","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_379"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tracking/paths/~1track~1u~1{token}/post"}],"panels":[]}]},"httpPath":"/track/u/{token}"}],"content":{"contentType":"group","meta":{"name":"Tracking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tracking","showPageActions":true},{"nodeType":"markdoc","content":"Public endpoints for open and click tracking.\nThese are called automatically by email clients - no authentication required."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/track/o/{token}","summary":"Track email open","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking/paths/~1track~1o~1{token}/get","deprecated":false},{"title":"/track/c/{token}","summary":"Track link click","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking/paths/~1track~1c~1{token}/get","deprecated":false},{"title":"/track/u/{token}","summary":"Unsubscribe (manual)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tracking/paths/~1track~1u~1{token}/get","deprecated":false},{"title":"/track/u/{token}","summary":"One-click unsubscribe (RFC 8058)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tracking/paths/~1track~1u~1{token}/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Outbound Webhooks","link":"/customer-api.openapi/outbound-webhooks","routeSlug":"/customer-api.openapi/outbound-webhooks","items":[{"type":"link","label":"contact.confirmed","link":"/customer-api.openapi/outbound-webhooks/contact.confirmed","routeSlug":"/customer-api.openapi/outbound-webhooks/contact.confirmed","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"contact.confirmed"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/contact.confirmed"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact.confirmed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a double opt-in contact confirms their subscription and moves from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"contact.confirmed\",\n  \"timestamp\": \"2026-07-06T14:24:18.321Z\",\n  \"data\": {\n    \"contact_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"email\": \"subscriber@example.com\",\n    \"previous_status\": \"pending_confirmation\",\n    \"status\": \"subscribed\",\n    \"confirmed_at\": \"2026-07-06T14:24:18.321Z\",\n    \"source\": \"newsletter\",\n    \"consent\": {\n      \"source_url\": \"https://example.com/newsletter\",\n      \"consent_text\": \"I agree to receive newsletters.\",\n      \"timestamp\": \"2026-07-06T14:20:15Z\"\n    }\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"contact.confirmed\",\n  \"timestamp\": \"2026-07-06T14:24:18.321Z\",\n  \"data\": {\n    \"contact_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"email\": \"subscriber@example.com\",\n    \"previous_status\": \"pending_confirmation\",\n    \"status\": \"subscribed\",\n    \"confirmed_at\": \"2026-07-06T14:24:18.321Z\",\n    \"source\": \"newsletter\",\n    \"consent\": {\n      \"source_url\": \"https://example.com/newsletter\",\n      \"consent_text\": \"I agree to receive newsletters.\",\n      \"timestamp\": \"2026-07-06T14:20:15Z\"\n    }\n  }\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"contact.tag_added","link":"/customer-api.openapi/outbound-webhooks/contact.tag_added","routeSlug":"/customer-api.openapi/outbound-webhooks/contact.tag_added","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"contact.tag_added"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/contact.tag_added"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact.tag_added"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a tag is added to a contact — via the tag endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v1/contacts/{id}/tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a contact create/update that includes tags, one event per tag added."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"contact.tag_added\",\n  \"timestamp\": \"2026-07-06T14:24:18.321Z\",\n  \"data\": {\n    \"contact_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"email\": \"subscriber@example.com\",\n    \"tag\": \"vip\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"contact.tag_added\",\n  \"timestamp\": \"2026-07-06T14:24:18.321Z\",\n  \"data\": {\n    \"contact_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"email\": \"subscriber@example.com\",\n    \"tag\": \"vip\"\n  }\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"contact.tag_removed","link":"/customer-api.openapi/outbound-webhooks/contact.tag_removed","routeSlug":"/customer-api.openapi/outbound-webhooks/contact.tag_removed","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"contact.tag_removed"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/contact.tag_removed"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact.tag_removed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a tag is removed from a contact — via the tag endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /api/v1/contacts/{id}/tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /api/v1/contacts/{id}/tags/{tagName}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a contact update that drops tags, one event per tag removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"contact.tag_removed\",\n  \"timestamp\": \"2026-07-06T14:25:02.410Z\",\n  \"data\": {\n    \"contact_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"email\": \"subscriber@example.com\",\n    \"tag\": \"trial-user\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"contact.tag_removed\",\n  \"timestamp\": \"2026-07-06T14:25:02.410Z\",\n  \"data\": {\n    \"contact_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"email\": \"subscriber@example.com\",\n    \"tag\": \"trial-user\"\n  }\n}\n"},"children":[]}]}]}],"panels":[]}]}},{"type":"link","label":"email.delivered","link":"/customer-api.openapi/outbound-webhooks/email.delivered","routeSlug":"/customer-api.openapi/outbound-webhooks/email.delivered","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"email.delivered"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/email.delivered"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email.delivered"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when email is successfully delivered to recipient's mail server."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"email.delivered\",\n  \"timestamp\": \"2025-12-27T12:34:56.789Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"to\": \"user@example.com\",\n  \"from\": \"sender@yourdomain.com\",\n  \"subject\": \"Welcome\",\n  \"deliveredAt\": \"2025-12-27T12:34:56.789Z\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"email.delivered\",\n  \"timestamp\": \"2025-12-27T12:34:56.789Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"to\": \"user@example.com\",\n  \"from\": \"sender@yourdomain.com\",\n  \"subject\": \"Welcome\",\n  \"deliveredAt\": \"2025-12-27T12:34:56.789Z\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are included if provided when sending the email."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"email.opened","link":"/customer-api.openapi/outbound-webhooks/email.opened","routeSlug":"/customer-api.openapi/outbound-webhooks/email.opened","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"email.opened"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/email.opened"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email.opened"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when recipient opens email (requires open tracking enabled)."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"email.opened\",\n  \"timestamp\": \"2025-12-27T12:35:23.456Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"ip_address\": \"203.0.113.45\",\n  \"user_agent\": \"Mozilla/5.0...\",\n  \"is_scanner\": false,\n  \"scanner_confidence\": 0,\n  \"browser\": \"Chrome\",\n  \"os\": \"Windows\",\n  \"device_type\": \"Desktop\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"email.opened\",\n  \"timestamp\": \"2025-12-27T12:35:23.456Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"ip_address\": \"203.0.113.45\",\n  \"user_agent\": \"Mozilla/5.0...\",\n  \"is_scanner\": false,\n  \"scanner_confidence\": 0,\n  \"browser\": \"Chrome\",\n  \"os\": \"Windows\",\n  \"device_type\": \"Desktop\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_scanner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates if the open was detected as an automated email scanner rather than human interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are included if provided when sending the email."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"email.clicked","link":"/customer-api.openapi/outbound-webhooks/email.clicked","routeSlug":"/customer-api.openapi/outbound-webhooks/email.clicked","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"email.clicked"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/email.clicked"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email.clicked"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when recipient clicks a tracked link."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"email.clicked\",\n  \"timestamp\": \"2025-12-27T12:36:15.123Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"url\": \"https://example.com/product\",\n  \"ip_address\": \"203.0.113.45\",\n  \"is_scanner\": false,\n  \"browser\": \"Safari\",\n  \"os\": \"iOS\",\n  \"device_type\": \"Mobile\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"email.clicked\",\n  \"timestamp\": \"2025-12-27T12:36:15.123Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"url\": \"https://example.com/product\",\n  \"ip_address\": \"203.0.113.45\",\n  \"is_scanner\": false,\n  \"browser\": \"Safari\",\n  \"os\": \"iOS\",\n  \"device_type\": \"Mobile\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are included if provided when sending the email."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"email.bounced","link":"/customer-api.openapi/outbound-webhooks/email.bounced","routeSlug":"/customer-api.openapi/outbound-webhooks/email.bounced","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"email.bounced"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/email.bounced"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email.bounced"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when email bounces (hard or soft)."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event_id\": \"email.bounced:550e8400-e29b-41d4-a716-446655440000\",\n  \"event\": \"email.bounced\",\n  \"timestamp\": \"2025-12-27T12:34:58.234Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"recipient\": \"invalid@example.com\",\n  \"bounce_type\": \"hard\",\n  \"bounce_category\": \"invalid_recipient\",\n  \"suppressed\": true,\n  \"reason\": \"User unknown\",\n  \"diagnostic_code\": \"550 5.1.1\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event_id\": \"email.bounced:550e8400-e29b-41d4-a716-446655440000\",\n  \"event\": \"email.bounced\",\n  \"timestamp\": \"2025-12-27T12:34:58.234Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"recipient\": \"invalid@example.com\",\n  \"bounce_type\": \"hard\",\n  \"bounce_category\": \"invalid_recipient\",\n  \"suppressed\": true,\n  \"reason\": \"User unknown\",\n  \"diagnostic_code\": \"550 5.1.1\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounce_category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sub-classifies the bounce: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_recipient"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailbox_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"policy_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reputation_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spam_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"content_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dns_failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transient_failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suppressed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates whether the recipient was added to the suppression"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_recipient"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bounces (and complaints) suppress"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permanently — policy/reputation/spam/mailbox-full blocks are recorded but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"do "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suppress, since they are sender-side or transient signals."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are included if provided when sending the email."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"email.complained","link":"/customer-api.openapi/outbound-webhooks/email.complained","routeSlug":"/customer-api.openapi/outbound-webhooks/email.complained","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"email.complained"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/email.complained"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email.complained"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when recipient marks email as spam."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"email.complained\",\n  \"timestamp\": \"2025-12-27T12:37:42.567Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"recipient\": \"user@example.com\",\n  \"complaint_type\": \"abuse\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"email.complained\",\n  \"timestamp\": \"2025-12-27T12:37:42.567Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"recipient\": \"user@example.com\",\n  \"complaint_type\": \"abuse\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complaints are automatically added to suppression list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are included if provided when sending the email."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"email.unsubscribed","link":"/customer-api.openapi/outbound-webhooks/email.unsubscribed","routeSlug":"/customer-api.openapi/outbound-webhooks/email.unsubscribed","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"email.unsubscribed"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/email.unsubscribed"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email.unsubscribed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when recipient unsubscribes."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"email.unsubscribed\",\n  \"timestamp\": \"2025-12-27T12:38:20.890Z\",\n  \"email\": \"user@example.com\",\n  \"reason\": \"User clicked unsubscribe link\",\n  \"method\": \"link\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"email.unsubscribed\",\n  \"timestamp\": \"2025-12-27T12:38:20.890Z\",\n  \"email\": \"user@example.com\",\n  \"reason\": \"User clicked unsubscribe link\",\n  \"method\": \"link\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Methods: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (clicked link) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"one-click"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (RFC 8058)."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"email.failed","link":"/customer-api.openapi/outbound-webhooks/email.failed","routeSlug":"/customer-api.openapi/outbound-webhooks/email.failed","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"email.failed"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"outbound-webhooks/email.failed"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when email fails to send."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event\": \"email.failed\",\n  \"timestamp\": \"2025-12-27T12:34:57.345Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"recipient\": \"blocked@example.com\",\n  \"reason\": \"Blocked by content filter\",\n  \"error\": \"Content violated filtering rules\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event\": \"email.failed\",\n  \"timestamp\": \"2025-12-27T12:34:57.345Z\",\n  \"email_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"recipient\": \"blocked@example.com\",\n  \"reason\": \"Blocked by content filter\",\n  \"error\": \"Content violated filtering rules\",\n  \"tag\": \"campaign-welcome\",\n  \"metadata\": {\n    \"campaign_id\": \"welcome-2025\",\n    \"customer_segment\": \"new-users\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are included if provided when sending the email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Respond quickly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Return 200 OK within 5 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Queue webhook for processing, respond immediately"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handle retries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Webhooks retry 5 times with exponential backoff if your endpoint fails"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate payloads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and validate structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use HTTPS"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Always use HTTPS endpoints for security"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing Webhooks:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use ngrok or webhook.site to test locally:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"ngrok http 3000\n# Create webhook with ngrok URL\ncurl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -d '{\"url\": \"https://abc123.ngrok.io/webhooks\", \"events\": [\"delivered\"]}'\n\n# Send a test webhook\ncurl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks/{WEBHOOK_ID}/test \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ngrok http 3000\n# Create webhook with ngrok URL\ncurl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -d '{\"url\": \"https://abc123.ngrok.io/webhooks\", \"events\": [\"delivered\"]}'\n\n# Send a test webhook\ncurl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks/{WEBHOOK_ID}/test \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Delivery:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery timeout: 30 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry attempts: 5 (with exponential backoff)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry schedule: 1s, 5s, 30s, 2m, 10m"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the complete integration guide at https://docs.mailerlogic.com/webhooks"},"children":[]}]}]}]}],"panels":[]}]}},{"label":"List webhook endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/get","routeSlug":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/get","metadata":{"seo":{"title":"List webhook endpoints","description":"Retrieve all configured webhook endpoints for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List webhook endpoints","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhook endpoints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all configured webhook endpoints for your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tier Limits:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starter: 1 webhook endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Professional: 3 webhook endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business: 10 webhook endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom: Configurable limit"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/customer/webhooks","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/customer/webhooks","href":"outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/get","summary":"List webhook endpoints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhooks retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/get"}],"panels":[]}]},"httpPath":"/api/v1/customer/webhooks"},{"label":"Create webhook endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/post","routeSlug":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/post","metadata":{"seo":{"title":"Create webhook endpoint","description":"Create a new webhook endpoint to receive real-time email event notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create webhook endpoint","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new webhook endpoint to receive real-time email event notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature verification:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every webhook created through this API receives an opaque signing secret in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the create response. MailerLogic computes a lowercase hexadecimal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC-SHA256 over the exact UTF-8 request body bytes and sends it in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not parse and re-serialize the JSON before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verification. Capture the raw request body, compute the HMAC with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved secret, and compare the two values using a constant-time comparison."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery requests also include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": webhook endpoint UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-MailerLogic-Event-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": stable event UUID for idempotent processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": event timestamp copied from the JSON payload"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Event-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": event name such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.delivered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook delivery is at least once. Deduplicate retries using the JSON"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or matching "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-MailerLogic-Event-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Scopes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-Level"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (domain_ids = null/empty): Receives events from ALL domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Domain"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (domain_ids = [uuid]): Receives events from ONE domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain Group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (domain_ids = [uuid1, uuid2, ...]): Receives events from MULTIPLE domains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Case - Plan Limits:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your plan has 20 domains but only 5 webhook endpoints, group domains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook 1: [marketing-domain, campaigns-domain, newsletters-domain] → marketing app"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook 2: [support-domain, tickets-domain] → support app"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook 3: [] (all remaining domains) → main backend"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email accepted for delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.delivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Successfully delivered to recipient"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Recipient opened the email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.clicked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Recipient clicked a link"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.bounced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Email bounced"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.complained"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Spam complaint received"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.unsubscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Recipient unsubscribed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email.failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Delivery failed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-level webhook (all domains):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"url\": \"https://api.example.com/webhook\",\n  \"events\": [\"email.delivered\", \"email.bounced\"],\n  \"domain_ids\": null\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"url\": \"https://api.example.com/webhook\",\n  \"events\": [\"email.delivered\", \"email.bounced\"],\n  \"domain_ids\": null\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain group webhook (multiple domains):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"url\": \"https://marketing.example.com/webhook\",\n  \"events\": [\"email.opened\", \"email.clicked\"],\n  \"domain_ids\": [\n    \"550e8400-e29b-41d4-a716-446655440001\",\n    \"550e8400-e29b-41d4-a716-446655440002\",\n    \"550e8400-e29b-41d4-a716-446655440003\"\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"url\": \"https://marketing.example.com/webhook\",\n  \"events\": [\"email.opened\", \"email.clicked\"],\n  \"domain_ids\": [\n    \"550e8400-e29b-41d4-a716-446655440001\",\n    \"550e8400-e29b-41d4-a716-446655440002\",\n    \"550e8400-e29b-41d4-a716-446655440003\"\n  ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single domain webhook (backward compatible):"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"url\": \"https://support.example.com/webhook\",\n  \"events\": [\"email.delivered\"],\n  \"domain_ids\": [\"550e8400-e29b-41d4-a716-446655440000\"]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"url\": \"https://support.example.com/webhook\",\n  \"events\": [\"email.delivered\"],\n  \"domain_ids\": [\"550e8400-e29b-41d4-a716-446655440000\"]\n}\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381","pointer":"/paths/~1api~1v1~1customer~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/webhooks","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_381"}},"responseCodes":["201","400","401","403"],"pointer":"/api/v1/customer/webhooks","href":"outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/post","summary":"Create webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_381"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook created successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ IMPORTANT:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field inside the webhook object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the ONLY time you'll see it - save it immediately!"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_382","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Webhook limit reached","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383"}],"pointer":"/paths/~1api~1v1~1customer~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_382","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/webhooks"},{"label":"Update webhook endpoint","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/put","routeSlug":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/put","metadata":{"seo":{"title":"Update webhook endpoint","description":"Update an existing webhook endpoint configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update webhook endpoint","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an existing webhook endpoint configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can change webhook scope by updating domain_ids:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to null or []: Change to customer-level (all domains)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to [uuid]: Change to single domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to [uuid1, uuid2, ...]: Change to domain group (multiple domains)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_245","description":"Webhook endpoint ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384","pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/customer/webhooks/{webhookId}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_384"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/customer/webhooks/{webhookId}","href":"outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/put","summary":"Update webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_384"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/put"}],"panels":[]}]},"httpPath":"/api/v1/customer/webhooks/{webhookId}"},{"label":"Partially update webhook endpoint","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/patch","routeSlug":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/patch","metadata":{"seo":{"title":"Partially update webhook endpoint","description":"Alias of PUT for partial webhook endpoint updates. You can change url, events, name, description, is_active, domain_ids, or deprecated domain_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Partially update webhook endpoint","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias of PUT for partial webhook endpoint updates. You can change "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or deprecated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses include both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for backward compatibility and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the standard single-resource shape."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_245","description":"Webhook endpoint ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/customer/webhooks/{webhookId}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_386"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/customer/webhooks/{webhookId}","href":"outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/patch","summary":"Partially update webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/patch"}],"panels":[]}]},"httpPath":"/api/v1/customer/webhooks/{webhookId}"},{"label":"Delete webhook endpoint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/delete","routeSlug":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/delete","metadata":{"seo":{"title":"Delete webhook endpoint","description":"Remove a webhook endpoint from your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete webhook endpoint","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a webhook endpoint from your account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_245","description":"Webhook endpoint ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/customer/webhooks/{webhookId}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/customer/webhooks/{webhookId}","href":"outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/delete","summary":"Delete webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/delete"}],"panels":[]}]},"httpPath":"/api/v1/customer/webhooks/{webhookId}"},{"label":"Test webhook endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1test/post","routeSlug":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1test/post","metadata":{"seo":{"title":"Test webhook endpoint","description":"Send a test event to verify webhook delivery."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Test webhook endpoint","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a test event to verify webhook delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test Event Format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event_id\": \"550e8400-e29b-41d4-a716-446655440099\",\n  \"event\": \"test\",\n  \"timestamp\": \"2026-01-18T12:34:56Z\",\n  \"data\": {\n    \"customer_id\": \"uuid\",\n    \"webhook_id\": \"uuid\",\n    \"message\": \"This is a test webhook from MailerLogic\"\n  }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event_id\": \"550e8400-e29b-41d4-a716-446655440099\",\n  \"event\": \"test\",\n  \"timestamp\": \"2026-01-18T12:34:56Z\",\n  \"data\": {\n    \"customer_id\": \"uuid\",\n    \"webhook_id\": \"uuid\",\n    \"message\": \"This is a test webhook from MailerLogic\"\n  }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The test request uses the same headers and raw-body HMAC-SHA256 signing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"algorithm as production webhook deliveries."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_245","description":"Webhook endpoint ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/webhooks/{webhookId}/test","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","409","502"],"pointer":"/api/v1/customer/webhooks/{webhookId}/test","href":"outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1test/post","summary":"Test webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Test webhook sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"The webhook predates signing and has no secret; regenerate it before testing"},{"code":"502","description":"The destination could not be reached or timed out"}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/404/content/application~1json/example"]}}},{"code":"409"},{"code":"502"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1test/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/webhooks/{webhookId}/test"},{"label":"Regenerate webhook secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1regenerate-secret/post","routeSlug":"/customer-api.openapi/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1regenerate-secret/post","metadata":{"seo":{"title":"Regenerate webhook secret","description":"Generate a new HMAC-SHA256 secret for webhook signature verification. The old secret will be immediately invalidated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Regenerate webhook secret","isWebhook":false,"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate webhook secret","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate a new HMAC-SHA256 secret for webhook signature verification.\nThe old secret will be immediately invalidated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_245","description":"Webhook endpoint ID","required":true}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/customer/webhooks/{webhookId}/regenerate-secret","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/customer/webhooks/{webhookId}/regenerate-secret","href":"outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1regenerate-secret/post","summary":"Regenerate webhook secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret regenerated successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ IMPORTANT:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The new secret is inside the webhook object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the ONLY time you'll see it - save it immediately!"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The old secret is now invalid."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_390","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_390","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1regenerate-secret/post"}],"panels":[]}]},"httpPath":"/api/v1/customer/webhooks/{webhookId}/regenerate-secret"}],"content":{"contentType":"group","meta":{"name":"Outbound Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Outbound Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MailerLogic sends real-time webhook notifications to your configured endpoint for all email events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Scopes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-Level Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (domain_ids = null or [])"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receives events from ALL domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simplest setup for single-backend applications"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Domain Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (domain_ids = [uuid])"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receives events from ONE specific domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful for isolated domains"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain Group Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (domain_ids = [uuid1, uuid2, ...])"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receives events from MULTIPLE specific domains"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perfect for grouping related domains when webhook endpoint limits apply"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Plan has 20 domains, 5 webhook limit → group marketing domains, support domains, etc."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mixed Approach"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can combine all three types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain-specific/group webhooks fire first, then customer-level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximize efficiency with limited webhook endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create customer-level webhook (all domains):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://your-app.com/webhooks/mailerlogic\",\n    \"events\": [\"email.delivered\", \"email.opened\", \"email.clicked\", \"email.bounced\", \"email.complained\"],\n    \"name\": \"Production Webhook\",\n    \"domain_ids\": null,\n    \"is_active\": true\n  }'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://your-app.com/webhooks/mailerlogic\",\n    \"events\": [\"email.delivered\", \"email.opened\", \"email.clicked\", \"email.bounced\", \"email.complained\"],\n    \"name\": \"Production Webhook\",\n    \"domain_ids\": null,\n    \"is_active\": true\n  }'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create domain group webhook (multiple domains):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://marketing.example.com/webhook\",\n    \"events\": [\"email.opened\", \"email.clicked\"],\n    \"name\": \"Marketing Domains Group\",\n    \"domain_ids\": [\n      \"550e8400-e29b-41d4-a716-446655440001\",\n      \"550e8400-e29b-41d4-a716-446655440002\",\n      \"550e8400-e29b-41d4-a716-446655440003\"\n    ],\n    \"is_active\": true\n  }'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://marketing.example.com/webhook\",\n    \"events\": [\"email.opened\", \"email.clicked\"],\n    \"name\": \"Marketing Domains Group\",\n    \"domain_ids\": [\n      \"550e8400-e29b-41d4-a716-446655440001\",\n      \"550e8400-e29b-41d4-a716-446655440002\",\n      \"550e8400-e29b-41d4-a716-446655440003\"\n    ],\n    \"is_active\": true\n  }'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create single domain webhook:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://support.example.com/webhook\",\n    \"events\": [\"email.delivered\", \"email.bounced\"],\n    \"name\": \"Support Domain Only\",\n    \"domain_ids\": [\"550e8400-e29b-41d4-a716-446655440000\"],\n    \"is_active\": true\n  }'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST https://api.mailerlogic.net/api/v1/customer/webhooks \\\n  -H \"X-API-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"url\": \"https://support.example.com/webhook\",\n    \"events\": [\"email.delivered\", \"email.bounced\"],\n    \"name\": \"Support Domain Only\",\n    \"domain_ids\": [\"550e8400-e29b-41d4-a716-446655440000\"],\n    \"is_active\": true\n  }'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All webhook events include:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Stable event identifier. Store this value and ignore a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery you have already processed; webhook delivery is at-least-once."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Event type (e.g., \"email.delivered\", \"email.opened\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - ISO 8601 timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - UUID of the email (except unsubscribe events)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Optional tag for filtering/grouping (if provided when sending)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Optional custom metadata object (if provided when sending)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events sent to your endpoint:"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/customer/webhooks","summary":"List webhook endpoints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/get","deprecated":false},{"title":"/api/v1/customer/webhooks","summary":"Create webhook endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks/post","deprecated":false},{"title":"/api/v1/customer/webhooks/{webhookId}","summary":"Update webhook endpoint","prefix":{"name":"put","color":"put"},"badges":[],"link":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/put","deprecated":false},{"title":"/api/v1/customer/webhooks/{webhookId}","summary":"Partially update webhook endpoint","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/patch","deprecated":false},{"title":"/api/v1/customer/webhooks/{webhookId}","summary":"Delete webhook endpoint","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}/delete","deprecated":false},{"title":"/api/v1/customer/webhooks/{webhookId}/test","summary":"Test webhook endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1test/post","deprecated":false},{"title":"/api/v1/customer/webhooks/{webhookId}/regenerate-secret","summary":"Regenerate webhook secret","prefix":{"name":"post","color":"post"},"badges":[],"link":"/outbound-webhooks/paths/~1api~1v1~1customer~1webhooks~1{webhookid}~1regenerate-secret/post","deprecated":false}]}]}]}]}},{"type":"separator","label":"CRM & Contacts","content":null},{"type":"group","label":"Contacts","link":"/customer-api.openapi/contacts","routeSlug":"/customer-api.openapi/contacts","items":[{"label":"List contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts/get","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts/get","metadata":{"seo":{"title":"List contacts","description":"Retrieve a paginated list of contacts for your account with filtering and search capabilities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List contacts","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a paginated list of contacts for your account with filtering and search capabilities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginated results (up to 1000 per page)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by status (subscribed, pending_confirmation, unsubscribed, bounced, complained)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search by email or name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by tag"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort by multiple fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns tags array for each contact"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_333","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_249","description":"Results per page (max 1000)"},{"name":"status","in":"query","schemaId":"schema_391","description":"Filter by contact status"},{"name":"search","in":"query","schemaId":"schema_258","description":"Search by email or name"},{"name":"email","in":"query","schemaId":"schema_344","description":"Exact case-insensitive email lookup. When supplied without status, all statuses are searched."},{"name":"tag","in":"query","schemaId":"schema_258","description":"Filter by specific tag"},{"name":"include_segments","in":"query","schemaId":"schema_392","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, each contact includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"segments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, name}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the segments it belongs to. Use this to render segment membership for a page of contacts in a single request instead of querying each segment separately. Internal system segments are excluded."},"children":[]}]}]}]},{"name":"sort_by","in":"query","schemaId":"schema_393"},{"name":"sort_order","in":"query","schemaId":"schema_394"}],"pointer":"/paths/~1api~1v1~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_333"},{"name":"limit","in":"query","schemaId":"schema_249"},{"name":"status","in":"query","schemaId":"schema_391"},{"name":"search","in":"query","schemaId":"schema_258"},{"name":"email","in":"query","schemaId":"schema_344"},{"name":"tag","in":"query","schemaId":"schema_258"},{"name":"include_segments","in":"query","schemaId":"schema_392"},{"name":"sort_by","in":"query","schemaId":"schema_393"},{"name":"sort_order","in":"query","schemaId":"schema_394"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/contacts","href":"contacts/paths/~1api~1v1~1contacts/get","summary":"List contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contacts retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395","exampleIds":["paths/~1api~1v1~1contacts/get/responses/200/content/application~1json/examples/with_engagement"]}},"schemaId":"schema_395","exampleIds":["paths/~1api~1v1~1contacts/get/responses/200/content/application~1json/examples/with_engagement"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_395","exampleIds":["paths/~1api~1v1~1contacts/get/responses/200/content/application~1json/examples/with_engagement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395","exampleIds":["paths/~1api~1v1~1contacts/get/responses/200/content/application~1json/examples/with_engagement"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts"},{"label":"Create a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts/post","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts/post","metadata":{"seo":{"title":"Create a contact","description":"Create a new contact in your account. You can include tags, custom properties, and all contact fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new contact in your account. You can include tags, custom properties, and all contact fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Backward compatibility:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contacts are still created as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" immediately unless you explicitly pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"double_opt_in: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Existing integrations using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: \"subscribed\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" continue to behave as single opt-in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Double opt-in:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"double_opt_in: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create the contact as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", send a confirmation email, and move the contact to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only after the subscriber confirms. Pending contacts are excluded from marketing segment sends until confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email (required) - unique per customer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name fields - first_name/last_name or combined name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact info - phone, city, country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom properties - unlimited flexible fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags - categorize your contacts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Email must be unique. Returns 409 if email already exists."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396","exampleIds":["paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/basic","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/double_opt_in"]}},"schemaId":"schema_396","exampleIds":["paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/basic","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/double_opt_in"],"pointer":"/paths/~1api~1v1~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_396","exampleIds":["paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/basic","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/double_opt_in"]}},"responseCodes":["201","400","401","409"],"pointer":"/api/v1/contacts","href":"contacts/paths/~1api~1v1~1contacts/post","summary":"Create a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_396","exampleIds":["paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/basic","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/double_opt_in"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396","exampleIds":["paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/basic","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/full","paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/double_opt_in"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Contact created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397"},{"code":"400","description":"Invalid request (missing email, invalid format, etc.)"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"Contact with this email already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"}],"pointer":"/paths/~1api~1v1~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts/post/responses/401/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts"},{"label":"Resend double opt-in confirmation email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post","metadata":{"seo":{"title":"Resend double opt-in confirmation email","description":"Resends the confirmation email for a contact in pending_confirmation status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Resend double opt-in confirmation email","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend double opt-in confirmation email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resends the confirmation email for a contact in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint only works for pending contacts created or updated with double opt-in. It applies resend cooldown protection to reduce abuse."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Contact ID","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399","pointer":"/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/{id}/send-confirmation","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_399"}},"responseCodes":["202","400","401","404","429"],"pointer":"/api/v1/contacts/{id}/send-confirmation","href":"contacts/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post","summary":"Resend double opt-in confirmation email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_399"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Confirmation email queued","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400"},{"code":"400","description":"Contact is not pending confirmation or sender/template settings are invalid"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"},{"code":"429","description":"Confirmation was sent recently; wait before retrying"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/responses/401/content/application~1json/example"]}}},{"code":"404"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}/send-confirmation"},{"label":"Confirm double opt-in subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1confirm~1{token}/get","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1confirm~1{token}/get","metadata":{"seo":{"title":"Confirm double opt-in subscription","description":"Public confirmation-link endpoint. When the token is valid and unexpired, the contact status changes from pending_confirmation to subscribed and a contact.confirmed webhook is queued."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Confirm double opt-in subscription","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1confirm~1{token}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm double opt-in subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Public confirmation-link endpoint. When the token is valid and unexpired, the contact status changes from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact.confirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhook is queued."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confirmation.redirect_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided when the confirmation was created or resent, successful confirmation redirects to that URL."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key using Bearer token authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this ONLY for Events Tracking API:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/events"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/emails/{email_id}/events"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer ml_live_1234567890abcdef...\n"},"children":[]}]}]}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"token","in":"path","schemaId":"schema_258","description":"Confirmation token from the confirmation email link","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1confirm~1{token}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/confirm/{token}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"token","in":"path","required":true,"schemaId":"schema_258"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"API Key"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","302","404","410"],"pointer":"/api/v1/contacts/confirm/{token}","href":"contacts/paths/~1api~1v1~1contacts~1confirm~1{token}/get","summary":"Confirm double opt-in subscription","securityGroups":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact confirmed"},{"code":"302","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Redirect after successful confirmation when redirect_url is configured"},"children":[]}]}]}]},{"code":"404","description":"Invalid confirmation token"},{"code":"410","description":"Confirmation token expired"}],"pointer":"/paths/~1api~1v1~1contacts~1confirm~1{token}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1confirm~1{token}/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/confirm/{token}"},{"label":"Bulk import contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1import/post","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1import/post","metadata":{"seo":{"title":"Bulk import contacts","description":"Import multiple contacts at once. Supports up to 10,000 contacts per request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Bulk import contacts","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk import contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import multiple contacts at once. Supports up to 10,000 contacts per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk import up to 10,000 contacts per request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choose conflict resolution strategy (skip or update)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support for all contact fields including custom properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags are automatically parsed and created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns detailed results (created, updated, skipped, errors)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email validation included"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction-based for data integrity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV import (after client-side parsing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration from other platforms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch contact creation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Syncing contacts from external systems"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always validate emails before sending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use batches of 1,000 for optimal performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_conflict: \"update\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to overwrite existing contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_conflict: \"skip\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to preserve existing data (default)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_401","exampleIds":["paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/basic_import","paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/full_import"]}},"schemaId":"schema_401","exampleIds":["paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/basic_import","paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/full_import"],"pointer":"/paths/~1api~1v1~1contacts~1import/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/import","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_401","exampleIds":["paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/basic_import","paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/full_import"]}},"responseCodes":["200","400","401","403","500"],"pointer":"/api/v1/contacts/import","href":"contacts/paths/~1api~1v1~1contacts~1import/post","summary":"Bulk import contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_401","exampleIds":["paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/basic_import","paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/full_import"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_401","exampleIds":["paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/basic_import","paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/full_import"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Import completed (may include partial failures)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/partial_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/update_mode"]}},"schemaId":"schema_402","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/partial_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/update_mode"]},{"code":"400","description":"Invalid request (empty array, too many contacts, etc.)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}},"schemaId":"schema_403"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"403","description":"Contact limit exceeded for your tier","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_404"}},"schemaId":"schema_404"},{"code":"500","description":"Server error during import","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405"}],"pointer":"/paths/~1api~1v1~1contacts~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_402","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/partial_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/update_mode"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/all_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/partial_success","paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/update_mode"]}}},{"code":"400","schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1import/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_404"}}},{"code":"500","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1import/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/import"},{"label":"Look up contact by email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1lookup/get","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1lookup/get","metadata":{"seo":{"title":"Look up contact by email","description":"Resolve a contact email address to its contact record. Returns 404 when no contact exists for the authenticated customer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Look up contact by email","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1lookup/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Look up contact by email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resolve a contact email address to its contact record. Returns 404 when no contact exists for the authenticated customer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_344","description":"Contact email address to look up","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1lookup/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/lookup","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","required":true,"schemaId":"schema_344"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/lookup","href":"contacts/paths/~1api~1v1~1contacts~1lookup/get","summary":"Look up contact by email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1lookup/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1lookup/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1lookup/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/lookup"},{"label":"Look up contact by email path","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1by-email~1{email}/get","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1by-email~1{email}/get","metadata":{"seo":{"title":"Look up contact by email path","description":"Resolve a contact by email using a path parameter. URL-encode the email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Look up contact by email path","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1by-email~1{email}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Look up contact by email path","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolve a contact by email using a path parameter. URL-encode the email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/contacts/lookup?email=..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new integrations because query parameters avoid path-encoding edge cases."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_344","description":"URL-encoded contact email address","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1by-email~1{email}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/by-email/{email}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_344"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/by-email/{email}","href":"contacts/paths/~1api~1v1~1contacts~1by-email~1{email}/get","summary":"Look up contact by email path"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact found"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1by-email~1{email}/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/by-email/{email}"},{"label":"Get a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}/get","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}/get","metadata":{"seo":{"title":"Get a contact","description":"Get detailed information about a specific contact including tags, segments, and engagement metrics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get a contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get detailed information about a specific contact including tags, segments, and engagement metrics.\n\nReturns all contact data plus the intelligent engagement score for easy segmentation and targeting.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Contact UUID","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/{id}","href":"contacts/paths/~1api~1v1~1contacts~1{id}/get","summary":"Get a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_407","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_407","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1{id}/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}/put","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}/put","metadata":{"seo":{"title":"Update a contact","description":"Update contact information including email address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update contact information including email address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email updates:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates email format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks for duplicates within your account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 409 if email already exists"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To update tags, use the dedicated tag endpoints."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408","pointer":"/paths/~1api~1v1~1contacts~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/contacts/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_408"}},"responseCodes":["200","400","401","404","409"],"pointer":"/api/v1/contacts/{id}","href":"contacts/paths/~1api~1v1~1contacts~1{id}/put","summary":"Update a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_408"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact updated successfully"},{"code":"400","description":"Invalid email format"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"},{"code":"409","description":"Email already exists for another contact"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"404"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1{id}/put"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}/delete","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}/delete","metadata":{"seo":{"title":"Delete a contact","description":"Permanently delete a contact from your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a contact from your account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/contacts/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/{id}","href":"contacts/paths/~1api~1v1~1contacts~1{id}/delete","summary":"Delete a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact deleted successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1{id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}"},{"label":"Get email history for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}~1emails/get","routeSlug":"/customer-api.openapi/contacts/paths/~1api~1v1~1contacts~1{id}~1emails/get","metadata":{"seo":{"title":"Get email history for a contact","description":"Retrieve all emails sent to a specific contact with engagement metrics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get email history for a contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}~1emails/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get email history for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all emails sent to a specific contact with engagement metrics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response includes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email subject, status, timestamps"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open/click counts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce and complaint information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event timeline (for recent emails)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display contact activity timeline"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show email engagement history"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track email deliverability per contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debug delivery issues"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","description":"Contact UUID","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1emails/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_333","description":"Page number (default 1)"},{"name":"limit","in":"query","schemaId":"schema_409","description":"Results per page (max 500, default 50)"},{"name":"status","in":"query","schemaId":"schema_410","description":"Filter by email status"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1emails/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/{id}/emails","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"page","in":"query","schemaId":"schema_333"},{"name":"limit","in":"query","schemaId":"schema_409"},{"name":"status","in":"query","schemaId":"schema_410"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/{id}/emails","href":"contacts/paths/~1api~1v1~1contacts~1{id}~1emails/get","summary":"Get email history for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email history retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_411","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1emails/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_411","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contacts/paths/~1api~1v1~1contacts~1{id}~1emails/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}/emails"}],"content":{"contentType":"group","meta":{"name":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete contact management system for organizing your subscribers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create, update, and delete contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search and filter contacts by status, source, tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track engagement metrics (opens, clicks, bounces)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields for flexible metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk import from CSV"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source tracking (API, import, form, manual)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build email lists programmatically"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Import existing subscriber lists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track contact lifecycle and engagement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment contacts for targeted campaigns"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/contacts","summary":"List contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts/get","deprecated":false},{"title":"/api/v1/contacts","summary":"Create a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts/post","deprecated":false},{"title":"/api/v1/contacts/{id}/send-confirmation","summary":"Resend double opt-in confirmation email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post","deprecated":false},{"title":"/api/v1/contacts/confirm/{token}","summary":"Confirm double opt-in subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1confirm~1{token}/get","deprecated":false},{"title":"/api/v1/contacts/import","summary":"Bulk import contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1import/post","deprecated":false},{"title":"/api/v1/contacts/lookup","summary":"Look up contact by email","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1lookup/get","deprecated":false},{"title":"/api/v1/contacts/by-email/{email}","summary":"Look up contact by email path","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1by-email~1{email}/get","deprecated":false},{"title":"/api/v1/contacts/{id}","summary":"Get a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1{id}/get","deprecated":false},{"title":"/api/v1/contacts/{id}","summary":"Update a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1{id}/put","deprecated":false},{"title":"/api/v1/contacts/{id}","summary":"Delete a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1{id}/delete","deprecated":false},{"title":"/api/v1/contacts/{id}/emails","summary":"Get email history for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/paths/~1api~1v1~1contacts~1{id}~1emails/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Segments","link":"/customer-api.openapi/segments","routeSlug":"/customer-api.openapi/segments","items":[{"label":"List segments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments/get","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments/get","metadata":{"seo":{"title":"List segments","description":"Retrieve all segments (both static and dynamic) for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List segments","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List segments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all segments (both static and dynamic) for your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response includes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment name, description, type (static/dynamic)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter conditions for dynamic segments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact count (actual membership count)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created/updated timestamps"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/segments","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/contacts/segments","href":"segments/paths/~1api~1v1~1contacts~1segments/get","summary":"List segments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Segments retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1segments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments"},{"label":"Create a segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments/post","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments/post","metadata":{"seo":{"title":"Create a segment","description":"Create a new segment (static or dynamic)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new segment (static or dynamic)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic Segments:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-update based on filter conditions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts added/removed automatically as they match/unmatch filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh on-demand or via cron"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static Segments:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual membership control"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contacts must be explicitly added/removed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful for one-time campaigns or curated lists"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Filters:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System Fields:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contact subscription status"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_equals"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unsubscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complained"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - How contact was added"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ends_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_empty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or any custom source"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact Info Fields:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_starts_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ends_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_ends_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_empty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: Any text string, comma-separated string, or string array."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-value examples:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"field\": \"email\", \"operator\": \"equals\", \"value\": [\"a@example.com\", \"b@example.com\"]}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"field\": \"email\", \"operator\": \"contains\", \"value\": \"gmail.com, yahoo.com\"}"},"children":[]}]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag Filters:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contact has any of these tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts_with"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: Array of tag names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"tag1\", \"tag2\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or comma-separated string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"tag1, tag2\""},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags_has_all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contact has ALL of these tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_all"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: Array of tag names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"tag1\", \"tag2\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or comma-separated string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"tag1, tag2\""},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags_not"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Contact does NOT have any of these tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_in"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: Array of tag names "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"tag1\", \"tag2\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or comma-separated string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"tag1, tag2\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign Engagement:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Campaign open tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_not_opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_least"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exactly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"more_than"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"less_than"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_most"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"never"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value: Campaign ID (UUID) or count number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional filters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (array), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_period_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_scanner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (boolean)"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_clicked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Campaign click tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_clicked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_not_clicked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_least"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exactly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"more_than"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"less_than"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"at_most"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"never"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value: Campaign ID (UUID) or count number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional filters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (array), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_period_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exclude_scanner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (boolean)"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Campaign delivery tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_not_received"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"was_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"was_not_sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value: Campaign ID (UUID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional filters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (array), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time_period_days"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date Filters:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in date fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_sent_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_properties.<property_name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed date operators:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exact_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": one calendar date, value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"2026-06-19\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": before a date/datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": after a date/datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_or_before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": on or before a date/datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on_or_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": on or after a date/datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fixed_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"between"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inclusive date range, value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"start\": \"2026-06-01\", \"end\": \"2026-06-19\" }"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic date operators:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yesterday"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_last"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"within_last_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"amount\": 7, \"unit\": \"days\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; unit can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"more_than"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"amount\": 30, \"unit\": \"days\" }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"days_ago"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weeks_ago"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"months_ago"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": value is the number of days/weeks/months ago"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"between_past_dates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"start\": \"2026-05-01\", \"end\": \"2026-05-31\" }"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty checks: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_empty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"never"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Properties:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_properties.<property_name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Filter by any custom property"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_starts_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ends_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_ends_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_empty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values: Any text or number based on property type. Text operators accept a string array or comma-separated string for multiple values."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-value Text Filters:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text/tag filters accept up to 100 values per rule."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The backend accepts both arrays and comma-separated strings, but new UIs should send arrays."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For positive operators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ends_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a contact matches if any supplied value matches."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For negative operators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_equals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_contains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_starts_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_ends_with"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), a contact matches only when none of the supplied values match."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Structure:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"filters\": [\n    {\n      \"field\": \"status\",\n      \"operator\": \"equals\",\n      \"value\": \"subscribed\"\n    },\n    {\n      \"field\": \"email\",\n      \"operator\": \"not_contains\",\n      \"value\": [\"example.com\", \"testmail.com\"]\n    },\n    {\n      \"field\": \"created_at\",\n      \"operator\": \"in_last\",\n      \"value\": { \"amount\": 30, \"unit\": \"days\" }\n    },\n    {\n      \"field\": \"custom_properties.company_size\",\n      \"operator\": \">=\",\n      \"value\": 100\n    }\n  ],\n  \"match_type\": \"all\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"filters\": [\n    {\n      \"field\": \"status\",\n      \"operator\": \"equals\",\n      \"value\": \"subscribed\"\n    },\n    {\n      \"field\": \"email\",\n      \"operator\": \"not_contains\",\n      \"value\": [\"example.com\", \"testmail.com\"]\n    },\n    {\n      \"field\": \"created_at\",\n      \"operator\": \"in_last\",\n      \"value\": { \"amount\": 30, \"unit\": \"days\" }\n    },\n    {\n      \"field\": \"custom_properties.company_size\",\n      \"operator\": \">=\",\n      \"value\": 100\n    }\n  ],\n  \"match_type\": \"all\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (AND) - Contact must match ALL filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (OR) - Contact must match ANY filter"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_413","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_filter_builder","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_custom_properties","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/static_segment"]}},"schemaId":"schema_413","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_filter_builder","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_custom_properties","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/static_segment"],"pointer":"/paths/~1api~1v1~1contacts~1segments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/segments","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_413","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_filter_builder","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_custom_properties","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/static_segment"]}},"responseCodes":["201","401","409"],"pointer":"/api/v1/contacts/segments","href":"segments/paths/~1api~1v1~1contacts~1segments/post","summary":"Create a segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_413","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_filter_builder","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_custom_properties","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/static_segment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_413","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_filter_builder","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_custom_properties","paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/static_segment"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Segment created successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"Segment with this name already exists"}],"pointer":"/paths/~1api~1v1~1contacts~1segments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments/post/responses/401/content/application~1json/example"]}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments"},{"label":"Get segment details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/get","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/get","metadata":{"seo":{"title":"Get segment details","description":"Get detailed information about a specific segment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get segment details","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get segment details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get detailed information about a specific segment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Include contacts list with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include_contacts=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_contacts","in":"query","schemaId":"schema_392","description":"Include paginated list of contacts in this segment"},{"name":"page","in":"query","schemaId":"schema_333"},{"name":"limit","in":"query","schemaId":"schema_249"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/segments/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[{"name":"include_contacts","in":"query","schemaId":"schema_392"},{"name":"page","in":"query","schemaId":"schema_333"},{"name":"limit","in":"query","schemaId":"schema_249"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/segments/{id}","href":"segments/paths/~1api~1v1~1contacts~1segments~1{id}/get","summary":"Get segment details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Segment retrieved successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/{id}"},{"label":"Update segment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/put","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/put","metadata":{"seo":{"title":"Update segment","description":"Update segment name, description, or filter conditions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update segment name, description, or filter conditions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For dynamic segments, updating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter_conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" recalculates membership during the update. You can also call POST /api/v1/contacts/segments/{id}/refresh to re-evaluate filters later."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414","pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/contacts/segments/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_414"}},"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/segments/{id}","href":"segments/paths/~1api~1v1~1contacts~1segments~1{id}/put","summary":"Update segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_414"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Segment updated successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/put"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/{id}"},{"label":"Partially update segment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/patch","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/patch","metadata":{"seo":{"title":"Partially update segment","description":"Alias of PUT for partial segment updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Partially update segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias of PUT for partial segment updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For dynamic segments, updating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter_conditions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" recalculates membership during the update. You can also call POST /api/v1/contacts/segments/{id}/refresh to re-evaluate filters later."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415","pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/contacts/segments/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_415"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/segments/{id}","href":"segments/paths/~1api~1v1~1contacts~1segments~1{id}/patch","summary":"Partially update segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_415"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Segment updated successfully"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/patch"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/{id}"},{"label":"Delete segment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/delete","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}/delete","metadata":{"seo":{"title":"Delete segment","description":"Delete a segment and all its memberships."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a segment and all its memberships."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warning:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This action cannot be undone. Contacts themselves are NOT deleted, only their segment membership."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/contacts/segments/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/segments/{id}","href":"segments/paths/~1api~1v1~1contacts~1segments~1{id}/delete","summary":"Delete segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Segment deleted successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/{id}"},{"label":"Refresh dynamic segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post","metadata":{"seo":{"title":"Refresh dynamic segment","description":"Re-evaluate filter conditions and update segment membership."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Refresh dynamic segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refresh dynamic segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-evaluate filter conditions and update segment membership."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After updating filter conditions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To sync segment with current contact data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before sending campaign to ensure up-to-date list"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only works for dynamic segments. Static segments return error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Refresh may take several seconds for large contact databases."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/segments/{id}/refresh","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/segments/{id}/refresh","href":"segments/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post","summary":"Refresh dynamic segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Segment refreshed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416"}},"schemaId":"schema_416"},{"code":"400","description":"Cannot refresh static segment"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_416","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416"}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/{id}/refresh"},{"label":"Preview segment filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1preview/post","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1preview/post","metadata":{"seo":{"title":"Preview segment filters","description":"Preview how many contacts match given filter conditions WITHOUT creating a segment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Preview segment filters","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview segment filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview how many contacts match given filter conditions WITHOUT creating a segment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test filters before creating segment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimate audience size for campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate filter logic"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact count only (no actual contact data for performance)"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","pointer":"/paths/~1api~1v1~1contacts~1segments~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/segments/preview","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_417"}},"responseCodes":["200","401"],"pointer":"/api/v1/contacts/segments/preview","href":"segments/paths/~1api~1v1~1contacts~1segments~1preview/post","summary":"Preview segment filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_417"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Preview count retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418"}},"schemaId":"schema_418"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1preview/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1preview/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_418","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1preview/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1preview/post/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1preview/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/preview"},{"label":"Add contacts to segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post","metadata":{"seo":{"title":"Add contacts to segment","description":"Manually add contacts to a segment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add contacts to segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add contacts to segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually add contacts to a segment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identify contacts by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_ids"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUIDs) or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emails"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — supply"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"whichever you have; if you send both, they are merged. Emails are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolved to contacts in your account, and any address with no matching"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact is returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unresolved_emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than being silently"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dropped (create those contacts first, e.g. via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /contacts/import"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static segments:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Adds contacts to membership"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic segments:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" NOT recommended - contacts will be removed on next refresh if they don't match filters"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419"}},"schemaId":"schema_419","pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/segments/{id}/contacts","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_419"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/segments/{id}/contacts","href":"segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post","summary":"Add contacts to segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_419","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_419"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contacts added successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Neither contact_ids nor emails supplied, invalid contact IDs, or a dynamic segment"},"children":[]}]}]}]},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found, or none of the supplied emails matched a contact"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}}},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/{id}/contacts"},{"label":"Remove contacts from segment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete","routeSlug":"/customer-api.openapi/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete","metadata":{"seo":{"title":"Remove contacts from segment","description":"Manually remove contacts from a segment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove contacts from segment","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove contacts from segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually remove contacts from a segment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static segments:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Removes contacts from membership"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic segments:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" NOT recommended - contacts may be re-added on next refresh if they match filters"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421","pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/contacts/segments/{id}/contacts","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_421"}},"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/segments/{id}/contacts","href":"segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete","summary":"Remove contacts from segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_421"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contacts removed successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Segment not found"}],"pointer":"/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete"}],"panels":[]}]},"httpPath":"/api/v1/contacts/segments/{id}/contacts"}],"content":{"contentType":"group","meta":{"name":"Segments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Segments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic and static audience segmentation for targeted campaigns."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic segments with auto-updating filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static segments with manual membership"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by engagement, status, source, tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview segment size before saving"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh dynamic segments on-demand"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Options:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status (subscribed, pending_confirmation, unsubscribed, bounced, complained)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source (api, import, form, manual)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Engagement metrics (opens, clicks, sent count)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags (AND/OR logic)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom field values"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Segments:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Highly engaged subscribers (>10 opens)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recent form signups (source=form, created <30 days)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At-risk contacts (sent >5, opened 0)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIP customers (tags contain \"premium\")"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/contacts/segments","summary":"List segments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments/get","deprecated":false},{"title":"/api/v1/contacts/segments","summary":"Create a segment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments/post","deprecated":false},{"title":"/api/v1/contacts/segments/{id}","summary":"Get segment details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/get","deprecated":false},{"title":"/api/v1/contacts/segments/{id}","summary":"Update segment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/put","deprecated":false},{"title":"/api/v1/contacts/segments/{id}","summary":"Partially update segment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/patch","deprecated":false},{"title":"/api/v1/contacts/segments/{id}","summary":"Delete segment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}/delete","deprecated":false},{"title":"/api/v1/contacts/segments/{id}/refresh","summary":"Refresh dynamic segment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post","deprecated":false},{"title":"/api/v1/contacts/segments/preview","summary":"Preview segment filters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1preview/post","deprecated":false},{"title":"/api/v1/contacts/segments/{id}/contacts","summary":"Add contacts to segment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post","deprecated":false},{"title":"/api/v1/contacts/segments/{id}/contacts","summary":"Remove contacts from segment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/segments/paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/customer-api.openapi/tags","routeSlug":"/customer-api.openapi/tags","items":[{"label":"List all tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1tags/get","routeSlug":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1tags/get","metadata":{"seo":{"title":"List all tags","description":"Get all unique tags used in your contacts with usage statistics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List all tags","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all unique tags used in your contacts with usage statistics."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/tags","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/contacts/tags","href":"tags/paths/~1api~1v1~1contacts~1tags/get","summary":"List all tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tags retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}},"schemaId":"schema_422"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/paths/~1api~1v1~1contacts~1tags/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/tags"},{"label":"Rename a tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1tags~1{tagname}/patch","routeSlug":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1tags~1{tagname}/patch","metadata":{"seo":{"title":"Rename a tag","description":"Rename a tag across all contacts. This updates the tag name everywhere it's used."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Rename a tag","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1tags~1{tagName}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rename a tag across all contacts. This updates the tag name everywhere it's used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fix typos: \"newsleter\" → \"newsletter\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change case: \"Newsletter\" → \"newsletter\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standardize naming: \"vip_customer\" → \"vip\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 404 if the tag doesn't exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 409 if the new name already exists (use merge instead)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atomic operation (all or nothing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Affects all contacts with this tag"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagName","in":"path","schemaId":"schema_258","description":"Current tag name to rename","required":true,"example":"newsleter"}],"pointer":"/paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_423","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/fixTypo","paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/changeCase"]}},"schemaId":"schema_423","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/fixTypo","paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/changeCase"],"pointer":"/paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/contacts/tags/{tagName}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"tagName","in":"path","required":true,"example":"newsleter","schemaId":"schema_258"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_423","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/fixTypo","paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/changeCase"]}},"responseCodes":["200","400","401","404","409"],"pointer":"/api/v1/contacts/tags/{tagName}","href":"tags/paths/~1api~1v1~1contacts~1tags~1{tagname}/patch","summary":"Rename a tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_423","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/fixTypo","paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/changeCase"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_423","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/fixTypo","paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/changeCase"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag renamed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424"}},"schemaId":"schema_424"},{"code":"400","description":"Invalid request (empty name, same name, invalid characters)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"409","description":"New tag name already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}},"schemaId":"schema_427"}],"pointer":"/paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_424","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_424"}}},{"code":"400","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"409","schemaId":"schema_427","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/paths/~1api~1v1~1contacts~1tags~1{tagname}/patch"}],"panels":[]}]},"httpPath":"/api/v1/contacts/tags/{tagName}"},{"label":"Merge multiple tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1tags~1merge/post","routeSlug":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1tags~1merge/post","metadata":{"seo":{"title":"Merge multiple tags","description":"Merge multiple tags into a single target tag. This is essential for cleaning up duplicate tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Merge multiple tags","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1tags~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge multiple tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merge multiple tags into a single target tag. This is essential for cleaning up duplicate tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Combine case variations: \"Newsletter\", \"newsletter\", \"NEWSLETTER\" → \"newsletter\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consolidate similar tags: \"vip\", \"VIP Customer\", \"vip-member\" → \"VIP\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fix duplicates after import: \"customer-2024\", \"customer-2025\" → \"customer\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each contact with any source tag:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds target tag (if not already present)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes all source tags"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Atomic operation (all or nothing)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns count of affected contacts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If contact has tags [\"Newsletter\", \"newsletter\"], merging both into \"newsletter\" results in just [\"newsletter\"]."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can include the target tag in source_tags array - it will handle this correctly."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_428","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/consolidateCaseVariations","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/mergeVIPTags","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/cleanupYearlyTags"]}},"schemaId":"schema_428","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/consolidateCaseVariations","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/mergeVIPTags","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/cleanupYearlyTags"],"pointer":"/paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/tags/merge","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_428","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/consolidateCaseVariations","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/mergeVIPTags","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/cleanupYearlyTags"]}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/tags/merge","href":"tags/paths/~1api~1v1~1contacts~1tags~1merge/post","summary":"Merge multiple tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_428","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/consolidateCaseVariations","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/mergeVIPTags","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/cleanupYearlyTags"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_428","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/consolidateCaseVariations","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/mergeVIPTags","paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/cleanupYearlyTags"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tags merged successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"schema_429","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}},"schemaId":"schema_430"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"None of the source tags exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}},"schemaId":"schema_431"}],"pointer":"/paths/~1api~1v1~1contacts~1tags~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_429","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_430","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1tags~1merge/post/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_431","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/paths/~1api~1v1~1contacts~1tags~1merge/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/tags/merge"},{"label":"Add tag(s) to contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1{id}~1tags/post","routeSlug":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1{id}~1tags/post","metadata":{"seo":{"title":"Add tag(s) to contact","description":"Add one or more tags to a contact. Supports both single tag and multiple tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add tag(s) to contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add tag(s) to contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add one or more tags to a contact. Supports both single tag and multiple tags."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_432"}},"schemaId":"schema_432","pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/{id}/tags","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_432"}},"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/{id}/tags","href":"tags/paths/~1api~1v1~1contacts~1{id}~1tags/post","summary":"Add tag(s) to contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_432","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_432"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tags added successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/post/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/paths/~1api~1v1~1contacts~1{id}~1tags/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}/tags"},{"label":"Remove tag from contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1{id}~1tags/delete","routeSlug":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1{id}~1tags/delete","metadata":{"seo":{"title":"Remove tag from contact","description":"Remove a specific tag from a contact using a JSON request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove tag from contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a specific tag from a contact using a JSON request body.\n\nPrefer this body-based endpoint for tag names that contain spaces or special characters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_433"}},"schemaId":"schema_433","pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/contacts/{id}/tags","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_433"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/{id}/tags","href":"tags/paths/~1api~1v1~1contacts~1{id}~1tags/delete","summary":"Remove tag from contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_433","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_433"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed successfully"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found or tag does not exist"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/paths/~1api~1v1~1contacts~1{id}~1tags/delete"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}/tags"},{"label":"Remove tag from contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagname}/delete","routeSlug":"/customer-api.openapi/tags/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagname}/delete","metadata":{"seo":{"title":"Remove tag from contact","description":"Remove a specific tag from a contact using a path parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove tag from contact","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove tag from contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a specific tag from a contact using a path parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be URL-encoded according to RFC 3986. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIP Customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIP%20Customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For new integrations, prefer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /api/v1/contacts/{id}/tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a JSON body to avoid path-encoding edge cases."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true},{"name":"tagName","in":"path","schemaId":"schema_258","required":true,"example":"premium"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/contacts/{id}/tags/{tagName}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"},{"name":"tagName","in":"path","required":true,"example":"premium","schemaId":"schema_258"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/{id}/tags/{tagName}","href":"tags/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagname}/delete","summary":"Remove tag from contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tag removed successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found or tag does not exist"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagname}/delete"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}/tags/{tagName}"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible tagging system for categorizing and organizing contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add/remove tags from contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all tags with usage counts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk tag operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter contacts by tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use in segment filters"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use lowercase, hyphenated names (e.g., \"early-adopter\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create tags for lifecycle stages (\"trial\", \"paid\", \"churned\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag by acquisition source (\"webinar-2024\", \"partner-referral\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag by interests or preferences (\"product-updates\", \"newsletters\")"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/contacts/tags","summary":"List all tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/paths/~1api~1v1~1contacts~1tags/get","deprecated":false},{"title":"/api/v1/contacts/tags/{tagName}","summary":"Rename a tag","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tags/paths/~1api~1v1~1contacts~1tags~1{tagname}/patch","deprecated":false},{"title":"/api/v1/contacts/tags/merge","summary":"Merge multiple tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/paths/~1api~1v1~1contacts~1tags~1merge/post","deprecated":false},{"title":"/api/v1/contacts/{id}/tags","summary":"Add tag(s) to contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/paths/~1api~1v1~1contacts~1{id}~1tags/post","deprecated":false},{"title":"/api/v1/contacts/{id}/tags","summary":"Remove tag from contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/paths/~1api~1v1~1contacts~1{id}~1tags/delete","deprecated":false},{"title":"/api/v1/contacts/{id}/tags/{tagName}","summary":"Remove tag from contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/paths/~1api~1v1~1contacts~1{id}~1tags~1{tagname}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Properties","link":"/customer-api.openapi/contact-properties","routeSlug":"/customer-api.openapi/contact-properties","items":[{"label":"List all property groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups/get","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups/get","metadata":{"seo":{"title":"List all property groups","description":"Get all property groups with their property counts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List all property groups","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all property groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all property groups with their property counts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/property-groups","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/contacts/property-groups","href":"contact-properties/paths/~1api~1v1~1contacts~1property-groups/get","summary":"List all property groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved property groups"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-groups"},{"label":"Create property group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups/post","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups/post","metadata":{"seo":{"title":"Create property group","description":"Create a new property group for organizing contact properties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create property group","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create property group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new property group for organizing contact properties."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434","pointer":"/paths/~1api~1v1~1contacts~1property-groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/property-groups","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_434"}},"responseCodes":["201","401","409"],"pointer":"/api/v1/contacts/property-groups","href":"contact-properties/paths/~1api~1v1~1contacts~1property-groups/post","summary":"Create property group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_434"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Property group created successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"A group with this name already exists"}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups/post/responses/401/content/application~1json/example"]}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-groups"},{"label":"Update property group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/put","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/put","metadata":{"seo":{"title":"Update property group","description":"Update a property group name, description, or display order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update property group","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update property group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a property group name, description, or display order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435","pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/contacts/property-groups/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_435"}},"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/property-groups/{id}","href":"contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/put","summary":"Update property group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_435"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property group updated successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/put"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-groups/{id}"},{"label":"Partially update property group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch","metadata":{"seo":{"title":"Partially update property group","description":"Alias of PUT for partial property group updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Partially update property group","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update property group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Alias of PUT for partial property group updates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436","pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/contacts/property-groups/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_436"}},"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/property-groups/{id}","href":"contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch","summary":"Partially update property group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_436"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property group updated successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-groups/{id}"},{"label":"Delete property group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete","metadata":{"seo":{"title":"Delete property group","description":"Delete a non-system property group. Groups containing properties cannot be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete property group","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete property group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a non-system property group. Groups containing properties cannot be deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/contacts/property-groups/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/property-groups/{id}","href":"contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete","summary":"Delete property group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property group deleted successfully"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-groups/{id}"},{"label":"List all property definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/get","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/get","metadata":{"seo":{"title":"List all property definitions","description":"Get all property definitions with types, validation rules, and metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List all property definitions","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-definitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all property definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all property definitions with types, validation rules, and metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property Types Available:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text, textarea, number, date, datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean, select, multi_select"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url, email, phone, json"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"group_id","in":"query","schemaId":"schema_245","description":"Filter by property group"}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/property-definitions","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[{"name":"group_id","in":"query","schemaId":"schema_245"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/contacts/property-definitions","href":"contact-properties/paths/~1api~1v1~1contacts~1property-definitions/get","summary":"List all property definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved property definitions"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-definitions"},{"label":"Create property definition","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/post","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/post","metadata":{"seo":{"title":"Create property definition","description":"Create a new typed property definition with validation and metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create property definition","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-definitions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create property definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new typed property definition with validation and metadata."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437","pointer":"/paths/~1api~1v1~1contacts~1property-definitions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/property-definitions","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_437"}},"responseCodes":["201","401","409"],"pointer":"/api/v1/contacts/property-definitions","href":"contact-properties/paths/~1api~1v1~1contacts~1property-definitions/post","summary":"Create property definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_437"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Property definition created successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"409","description":"A property with this key already exists"}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions/post/responses/401/content/application~1json/example"]}}},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-definitions"},{"label":"Get property definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get","metadata":{"seo":{"title":"Get property definition","description":"Get a single property definition by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get property definition","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get property definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a single property definition by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/property-definitions/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/property-definitions/{id}","href":"contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get","summary":"Get property definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property definition retrieved successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-definitions/{id}"},{"label":"Update property definition","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put","metadata":{"seo":{"title":"Update property definition","description":"Update a property definition label, description, type, options, validation rules, visibility, display order, and related metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update property definition","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update property definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a property definition label, description, type, options, validation rules, visibility, display order, and related metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not rewrite existing contact property values. Integrators should migrate existing values if needed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_438"}},"schemaId":"schema_438","pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/contacts/property-definitions/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_438"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/property-definitions/{id}","href":"contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put","summary":"Update property definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_438","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_438"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property definition updated successfully"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-definitions/{id}"},{"label":"Partially update property definition","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch","metadata":{"seo":{"title":"Partially update property definition","description":"Alias of PUT for partial property definition updates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Partially update property definition","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update property definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Alias of PUT for partial property definition updates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439","pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/contacts/property-definitions/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_439"}},"responseCodes":["200","400","401","404"],"pointer":"/api/v1/contacts/property-definitions/{id}","href":"contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch","summary":"Partially update property definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_439"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property definition updated successfully"},{"code":"400","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/400/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-definitions/{id}"},{"label":"Delete property definition","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete","metadata":{"seo":{"title":"Delete property definition","description":"Delete a non-system property definition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete property definition","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete property definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a non-system property definition."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/contacts/property-definitions/{id}","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/property-definitions/{id}","href":"contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete","summary":"Delete property definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property definition deleted successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/404/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete"}],"panels":[]}]},"httpPath":"/api/v1/contacts/property-definitions/{id}"},{"label":"Discover property keys (schema-less)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1custom-properties~1keys/get","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1custom-properties~1keys/get","metadata":{"seo":{"title":"Discover property keys (schema-less)","description":"Get all custom property keys used across your contacts with usage statistics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Discover property keys (schema-less)","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1custom-properties~1keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discover property keys (schema-less)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all custom property keys used across your contacts with usage statistics."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/custom-properties/keys","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/contacts/custom-properties/keys","href":"contact-properties/paths/~1api~1v1~1contacts~1custom-properties~1keys/get","summary":"Discover property keys (schema-less)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved property keys"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1custom-properties~1keys/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1custom-properties~1keys/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1custom-properties~1keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1custom-properties~1keys/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1custom-properties~1keys/get/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1custom-properties~1keys/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/custom-properties/keys"},{"label":"Get contact properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get","metadata":{"seo":{"title":"Get contact properties","description":"Get all custom properties for a specific contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get contact properties","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contact properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all custom properties for a specific contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contacts/{id}/custom-properties","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/{id}/custom-properties","href":"contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get","summary":"Get contact properties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved custom properties"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}/custom-properties"},{"label":"Update properties (merge)","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put","metadata":{"seo":{"title":"Update properties (merge)","description":"Add or update custom properties while keeping existing ones."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update properties (merge)","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update properties (merge)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add or update custom properties while keeping existing ones."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_245","required":true}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440","pointer":"/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/contacts/{id}/custom-properties","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_245"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_440"}},"responseCodes":["200","401","404"],"pointer":"/api/v1/contacts/{id}/custom-properties","href":"contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put","summary":"Update properties (merge)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_440"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Properties updated successfully"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"},{"code":"404","description":"Contact not found"}],"pointer":"/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/responses/401/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put"}],"panels":[]}]},"httpPath":"/api/v1/contacts/{id}/custom-properties"},{"label":"Search contacts by property","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1search-by-property/post","routeSlug":"/customer-api.openapi/contact-properties/paths/~1api~1v1~1contacts~1search-by-property/post","metadata":{"seo":{"title":"Search contacts by property","description":"Find contacts based on custom property values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search contacts by property","isWebhook":false,"pointer":"/paths/~1api~1v1~1contacts~1search-by-property/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search contacts by property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find contacts based on custom property values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" =, exists, contains"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_441"}},"schemaId":"schema_441","pointer":"/paths/~1api~1v1~1contacts~1search-by-property/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/contacts/search-by-property","servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_441"}},"responseCodes":["200","400","401"],"pointer":"/api/v1/contacts/search-by-property","href":"contact-properties/paths/~1api~1v1~1contacts~1search-by-property/post","summary":"Search contacts by property"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}],"schemaId":"schema_441","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_441"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search results with pagination"},{"code":"400","description":"Invalid operator"},{"code":"401","description":"Authentication failed or missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1search-by-property/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1search-by-property/post/responses/401/content/application~1json/example"],"headers":{"X-Request-ID":{"description":"Request identifier for support","schema":{"type":"string"}}},"headerSchemaId":"schema_235"}],"pointer":"/paths/~1api~1v1~1contacts~1search-by-property/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400"},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1search-by-property/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1api~1v1~1contacts~1search-by-property/post/responses/401/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-properties/paths/~1api~1v1~1contacts~1search-by-property/post"}],"panels":[]}]},"httpPath":"/api/v1/contacts/search-by-property"}],"content":{"contentType":"group","meta":{"name":"Contact Properties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Properties","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Centralized property definition system for managing contact fields (HubSpot-style)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two Approaches Available:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Centralized Definitions (Recommended for CRM)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define properties with types (text, number, date, select, boolean)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organize in groups (Contact Info, Company Info, Custom Fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set validation rules and default values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create dropdown options for select fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage through UI (create, edit, delete, reorder)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Schema-less (Flexible)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add any property on-the-fly to contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No central definition needed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum flexibility for integrations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System discovers what's in use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both approaches can coexist!"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property Types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text, textarea, number, date, datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean, select, multi_select"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"url, email, phone, json"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property groups for organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required/optional fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visibility controls"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Help text and placeholders"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type-based validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage statistics"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRM contact fields (company, job_title, industry)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lead scoring (lead_score, engagement_level)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-commerce data (lifetime_value, last_purchase)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom tracking fields (utm_campaign, referral_code)"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/contacts/property-groups","summary":"List all property groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups/get","deprecated":false},{"title":"/api/v1/contacts/property-groups","summary":"Create property group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups/post","deprecated":false},{"title":"/api/v1/contacts/property-groups/{id}","summary":"Update property group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/put","deprecated":false},{"title":"/api/v1/contacts/property-groups/{id}","summary":"Partially update property group","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/patch","deprecated":false},{"title":"/api/v1/contacts/property-groups/{id}","summary":"Delete property group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-groups~1{id}/delete","deprecated":false},{"title":"/api/v1/contacts/property-definitions","summary":"List all property definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/get","deprecated":false},{"title":"/api/v1/contacts/property-definitions","summary":"Create property definition","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions/post","deprecated":false},{"title":"/api/v1/contacts/property-definitions/{id}","summary":"Get property definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/get","deprecated":false},{"title":"/api/v1/contacts/property-definitions/{id}","summary":"Update property definition","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/put","deprecated":false},{"title":"/api/v1/contacts/property-definitions/{id}","summary":"Partially update property definition","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch","deprecated":false},{"title":"/api/v1/contacts/property-definitions/{id}","summary":"Delete property definition","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete","deprecated":false},{"title":"/api/v1/contacts/custom-properties/keys","summary":"Discover property keys (schema-less)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1custom-properties~1keys/get","deprecated":false},{"title":"/api/v1/contacts/{id}/custom-properties","summary":"Get contact properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/get","deprecated":false},{"title":"/api/v1/contacts/{id}/custom-properties","summary":"Update properties (merge)","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1{id}~1custom-properties/put","deprecated":false},{"title":"/api/v1/contacts/search-by-property","summary":"Search contacts by property","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contact-properties/paths/~1api~1v1~1contacts~1search-by-property/post","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Customer":{"id":"components/schemas/Customer","kind":"json-schema","title":"Customer","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"status":{"type":"string","enum":["active","suspended","pending"]},"tracking_enabled":{"type":"boolean"},"click_tracking_enabled":{"type":"boolean"},"open_tracking_enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"}}}},"components/schemas/CustomerProfile":{"id":"components/schemas/CustomerProfile","kind":"json-schema","title":"CustomerProfile","data":{"allOf":[{"$ref":"#/components/schemas/Customer"},{"type":"object","properties":{"monthly_email_limit":{"type":"integer","description":"Monthly email sending limit"},"max_domains":{"type":"integer","description":"Maximum number of domains allowed"},"webhook_endpoints_limit":{"type":"integer","description":"Maximum number of webhook endpoints allowed (1-50)","example":10},"current_domains":{"type":"integer","description":"Current number of domains registered"},"emails_sent_this_month":{"type":"integer","description":"Emails sent in current month"},"remaining_emails":{"type":"integer","description":"Remaining emails for current month"},"block_disposable_emails":{"type":"boolean","description":"Block emails to disposable/temporary domains","default":true},"enforce_sender_verification":{"type":"boolean","description":"Require DKIM/SPF verification before sending","default":true}}}]}},"components/schemas/Domain":{"id":"components/schemas/Domain","kind":"json-schema","title":"Domain","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"verification_status":{"type":"string","enum":["pending","verified","failed"]},"security_status":{"type":"string","enum":["pending_scan","active","under_review","suspended"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent security-reputation state, separate from DNS"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verification. A domain must be both DNS-verified and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"security_status: active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before it can send."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_scan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": newly added; automated reputation scan in progress."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends are soft-blocked and retriable until it clears (usually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"seconds to minutes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": cleared — sending allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"under_review"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": flagged for security review; sending blocked until cleared."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": blocked for abuse/security reasons; contact support."},"children":[]}]}]}]}]},"sending_allowed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Convenience flag — true only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"security_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"dkim_selector":{"type":"string"},"spf_record":{"type":"string"},"dmarc_record":{"type":"string"},"is_active":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"verified_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"tracking_domain_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the explicitly assigned tracking domain (null if using smart matching)"},"assignment_type":{"type":"string","enum":["explicit","smart_matching"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the tracking domain is assigned:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"explicit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Manually assigned via PUT /api/v1/customer/domains/:id/tracking-domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smart_matching"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Automatic assignment based on best match"},"children":[]}]}]}]}]},"tracking_domain_info":{"type":"object","nullable":true,"description":"Details of the assigned tracking domain (null if no tracking domain assigned)","properties":{"tracking_domain":{"type":"string","description":"The tracking domain name","example":"track.example.com"},"is_verified":{"type":"boolean","description":"Whether the tracking domain is verified"}}}}}},"components/schemas/DomainDetail":{"id":"components/schemas/DomainDetail","kind":"json-schema","title":"DomainDetail","data":{"allOf":[{"$ref":"#/components/schemas/Domain"},{"type":"object","properties":{"verification_token":{"type":"string"},"dkim_private_key":{"type":"string","description":"DKIM private key (keep secure!)"},"dkim_public_key":{"type":"string"}}}]}},"components/schemas/DNSRecord":{"id":"components/schemas/DNSRecord","kind":"json-schema","title":"DNSRecord","data":{"type":"object","properties":{"type":{"type":"string","enum":["TXT","MX","CNAME"]},"name":{"type":"string","description":"DNS record name/host"},"value":{"type":"string","description":"DNS record value"},"description":{"type":"string","description":"Human-readable description"}}}},"components/schemas/WebhookEndpoint":{"id":"components/schemas/WebhookEndpoint","kind":"json-schema","title":"WebhookEndpoint","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Webhook endpoint ID"},"customer_id":{"type":"string","format":"uuid","description":"Customer ID"},"domain_ids":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of domain UUIDs this webhook receives events from."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or empty: webhook is customer-level (receives events from ALL domains)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If array with UUIDs: webhook receives events from those specific domains"},"children":[]}]}]}]}],"example":["550e8400-e29b-41d4-a716-446655440001","550e8400-e29b-41d4-a716-446655440002"]},"domains":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"domain":{"type":"string"}}},"description":"Array of domain objects with id and domain name","example":[{"id":"550e8400-e29b-41d4-a716-446655440001","domain":"marketing.example.com"},{"id":"550e8400-e29b-41d4-a716-446655440002","domain":"campaigns.example.com"}]},"name":{"type":"string","nullable":true,"description":"Optional webhook identifier","example":"Production Webhook"},"url":{"type":"string","format":"uri","description":"HTTPS URL for webhook delivery","example":"https://api.example.com/webhooks/email-events"},"description":{"type":"string","nullable":true,"description":"Optional notes about this webhook","example":"Main production webhook for email events"},"events":{"type":"array","description":"Event types this webhook receives","items":{"type":"string","enum":["email.sent","email.delivered","email.opened","email.clicked","email.bounced","email.complained","email.unsubscribed","email.failed","contact.created","contact.updated","contact.unsubscribed","contact.deleted","contact.tag_added","contact.tag_removed","contact.confirmed"]},"example":["email.delivered","email.opened","email.clicked","email.bounced"]},"is_active":{"type":"boolean","description":"Whether webhook is enabled","default":true},"last_triggered_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp of last webhook delivery"},"last_status":{"type":"integer","nullable":true,"description":"HTTP status code from last delivery","example":200},"created_at":{"type":"string","format":"date-time","description":"When webhook was created"},"updated_at":{"type":"string","format":"date-time","description":"When webhook was last updated"}}}},"components/schemas/WebhookEndpointWithSecret":{"id":"components/schemas/WebhookEndpointWithSecret","kind":"json-schema","title":"WebhookEndpointWithSecret","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook endpoint response that includes the signing secret."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The secret is only returned when creating or regenerating."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Save it securely - you won't see it again!"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/WebhookEndpoint"},{"type":"object","properties":{"secret":{"type":"string","minLength":64,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque webhook signing secret. Current secrets are 64-character"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hexadecimal strings, but integrations must treat the value as opaque."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRITICAL:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Save this immediately! It's only shown once."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify against the exact raw UTF-8 request body bytes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"expected = lowercase_hex(HMAC-SHA256(secret, raw_request_body))\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"expected = lowercase_hex(HMAC-SHA256(secret, raw_request_body))\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compare "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using a constant-time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comparison. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to deduplicate at-least-once retries."},"children":[]}]}]}],"example":"8f2b5d8c8f4544e4b11682a4d7e0f681ab12cd34ef56ab78cd90ef12ab34cd56"},"signing_secret":{"type":"string","minLength":64,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated response alias of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", retained for backward"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"compatibility with integrations built against the former runtime"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response. It is returned only on create and regenerate, and always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contains the same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"8f2b5d8c8f4544e4b11682a4d7e0f681ab12cd34ef56ab78cd90ef12ab34cd56"}}}]}},"components/schemas/SMTPCredentials":{"id":"components/schemas/SMTPCredentials","kind":"json-schema","title":"SMTPCredentials","data":{"type":"object","properties":{"customer_id":{"type":"string","format":"uuid"},"customer_name":{"type":"string"},"smtp_credentials":{"$ref":"#/components/schemas/SMTPCredentialsDetail"},"note":{"type":"string"}}}},"components/schemas/SMTPCredentialsDetail":{"id":"components/schemas/SMTPCredentialsDetail","kind":"json-schema","title":"SMTPCredentialsDetail","data":{"type":"object","properties":{"host":{"type":"string","description":"SMTP server hostname","example":"smtp.mailerlogic.net"},"ports":{"type":"array","items":{"type":"integer"},"description":"Available SMTP ports"},"recommended_port":{"type":"integer","description":"Recommended port (usually 587 for STARTTLS)"},"username":{"type":"string","description":"SMTP username (customer email)"},"password":{"type":"string","description":"SMTP password"}}}},"components/schemas/UsageStatistics":{"id":"components/schemas/UsageStatistics","kind":"json-schema","title":"UsageStatistics","data":{"type":"object","properties":{"current_month":{"type":"object","properties":{"emails_sent":{"type":"integer"},"emails_delivered":{"type":"integer"},"emails_bounced":{"type":"integer"},"emails_complained":{"type":"integer"},"emails_opened":{"type":"integer"},"emails_clicked":{"type":"integer"},"delivery_rate":{"type":"string","description":"Percentage as string (e.g., \"99.16\")"},"bounce_rate":{"type":"string","description":"Percentage as string"}}},"limits":{"type":"object","properties":{"monthly_limit":{"type":"integer"},"remaining":{"type":"integer"},"used_percentage":{"type":"string","description":"Percentage as string"}}}}}},"components/schemas/OutboundStats":{"id":"components/schemas/OutboundStats","kind":"json-schema","title":"OutboundStats","data":{"type":"object","properties":{"sent":{"type":"integer"},"delivered":{"type":"integer"},"bounced":{"type":"integer"},"failed":{"type":"integer"},"opens":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total opens (filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter)"},"children":[]}]}]}]},"unique_opens":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique opens (filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter)"},"children":[]}]}]}]},"clicks":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total clicks (filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter)"},"children":[]}]}]}]},"human_opens":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Confidence-Based Detection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Opens classified as human (confidence < 50)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real user engagement excluding Gmail/Outlook image prefetch and security scanners."},"children":[]}]}]}]},"scanner_opens":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Confidence-Based Detection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Opens classified as scanners (confidence >= 80)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known email security scanners, bots, and automated systems."},"children":[]}]}]}]},"human_clicks":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Confidence-Based Detection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Clicks classified as human (confidence < 50)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real user clicks excluding security scanner pre-fetches."},"children":[]}]}]}]},"scanner_clicks":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Confidence-Based Detection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Clicks classified as scanners (confidence >= 80)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated clicks from security systems."},"children":[]}]}]}]},"human_open_rate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of emails opened by real humans (human_opens / sent * 100)"},"children":[]}]}]}],"example":"15.50"},"human_click_rate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of emails clicked by real humans (human_clicks / sent * 100)"},"children":[]}]}]}],"example":"8.25"},"unique_clicks":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique clicks (filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter)"},"children":[]}]}]}]},"spam_complaints":{"type":"integer"},"tracked":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total tracked events (opens + clicks, filtered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter)"},"children":[]}]}]}]}}}},"components/schemas/EmailEvent":{"id":"components/schemas/EmailEvent","kind":"json-schema","title":"EmailEvent","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email_id":{"type":"string","format":"uuid"},"customer_id":{"type":"string","format":"uuid"},"event_type":{"type":"string","enum":["queued","sent","delivered","bounced","failed","deferred","complained","opened","clicked","unsubscribed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bounced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Permanent delivery failure (hard bounce)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Temporary failure exhausted retries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deferred"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Currently retrying temporary failure"},"children":[]}]}]}]}]},"status":{"type":"string"},"recipient":{"type":"string","format":"email"},"from":{"type":"string","format":"email"},"timestamp":{"type":"string","format":"date-time"},"is_scanner":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence-Based Scanner Detection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Indicates if this open/click was classified as a high-confidence bot/scanner."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Scanner (confidence >= 80) - Known email security systems, bots"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Human or Suspicious (confidence < 80) - Real users or edge cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not included = Not applicable (event type is not 'opened' or 'clicked')"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner_confidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for granular classification."},"children":[]}]}]}]},"scanner_label":{"type":"string","enum":["scanner","suspicious","human"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Three-Tier Classification:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = High confidence bot/scanner (>= 80) - Security systems, known bots"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspicious"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Medium confidence (50-79) - Edge cases, possible automation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Low confidence (< 50) - Real user engagement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not included = Not applicable (event type is not 'opened' or 'clicked')"},"children":[]}]}]}]}]},"scanner_source":{"type":"string","enum":["scanner","suspicious","human","proxy"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confidence-Based Detection Source:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Primary classification result."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = High confidence scanner (>= 80)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspicious"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Medium confidence, needs review (50-79)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Low confidence, likely real user (< 50)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proxy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Privacy proxy detected (Apple Mail, iCloud Private Relay)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not included = Not applicable"},"children":[]}]}]}]}]},"scanner_confidence":{"type":"integer","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Confidence Score (0-100):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Numeric confidence score based on multiple signals:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scoring Factors:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known scanner ASN: +60 (Proofpoint, Mimecast, Barracuda)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scanner user-agent: +40-60 (curl, headless browsers, security tools)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instant click (<150ms): +30"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No referer header: +20 (Gmail/Outlook strip this legitimately)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Residential/mobile IP: -40 (strong human signal)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real browser UA: -40 (Chrome, Firefox, Safari, Edge)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human timing (>1s): -25"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webmail client (Gmail/Outlook Web): -40"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classification Thresholds:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"= 80: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (is_scanner = true)"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"50-79: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspicious"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (is_scanner = false)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"< 50: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (is_scanner = false)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Gmail user clicking after 5s = 0-20 confidence (human)"},"children":[]}]}]}]},"is_human_engagement":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Convenience Field:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Quick boolean indicating real human engagement."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Real human engagement (scanner_confidence < 50)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Bot/scanner or suspicious (scanner_confidence >= 50)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only included for 'opened' and 'clicked' events"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Premium Feature:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field provides quick access to human engagement detection."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to filter out bot/scanner activity from your analytics."},"children":[]}]}]}]},"scanner_detection":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Convenience Object:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pre-parsed scanner detection data for easy access."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only included for 'opened' and 'clicked' events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Premium Feature:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Detailed scanner detection information in a structured format."},"children":[]}]}]}],"properties":{"is_scanner":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High confidence scanner (>= 80)"},"children":[]}]}]}]},"scanner_label":{"type":"string","enum":["scanner","suspicious","human"],"description":"Three-tier classification"},"scanner_confidence":{"type":"integer","description":"Confidence score (0-100)"},"scanner_reason":{"type":"string","description":"Human-readable explanation of the classification"}},"example":{"is_scanner":false,"scanner_label":"human","scanner_confidence":15,"scanner_reason":"Real browser detected: firefox; Human-like delay: 138.8s; Residential IP"}},"device_info":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Convenience Object:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pre-parsed device and browser information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only included for 'opened' and 'clicked' events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Premium Feature:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Device analytics extracted from user-agent and IP data."},"children":[]}]}]}],"properties":{"os":{"type":"string","description":"Operating system (e.g., Windows, macOS, iOS, Android, Linux)"},"browser":{"type":"string","description":"Browser name (e.g., Chrome, Firefox, Safari, Edge)"},"device_type":{"type":"string","description":"Device type (Desktop, Mobile, Tablet)"},"user_agent":{"type":"string","description":"Full user-agent string"},"ip_address":{"type":"string","description":"IP address (may be redacted based on privacy level)"}},"example":{"os":"Windows","browser":"Firefox","device_type":"Desktop","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:133.0) Gecko/20100101 Firefox/133.0","ip_address":"192.168.1.100"}},"event_data":{"type":"object","description":"Additional event metadata (may be redacted based on privacy level)"},"created_at":{"type":"string","format":"date-time"}}}},"components/schemas/ContentScoreResult":{"id":"components/schemas/ContentScoreResult","kind":"json-schema","title":"ContentScoreResult","data":{"type":"object","properties":{"status":{"type":"string","enum":["ok","error"]},"score":{"type":"integer","minimum":0,"maximum":100,"description":"Content score (0-100, higher is better)"},"risk_level":{"type":"string","enum":["low","medium","high","critical"],"description":"Risk level assessment"},"matches":{"type":"array","items":{"type":"object","properties":{"rule_code":{"type":"string"},"severity":{"type":"string","enum":["low","medium","high","critical"]},"category":{"type":"string"},"message":{"type":"string"},"location":{"type":"string","enum":["subject","html","text"]}}}},"suggestions":{"type":"array","items":{"type":"string"},"description":"Actionable suggestions to improve score"},"usage":{"type":"object","properties":{"used":{"type":"integer"},"limit":{"type":"integer"},"period":{"type":"string"}}}}}},"components/schemas/Unsubscribe":{"id":"components/schemas/Unsubscribe","kind":"json-schema","title":"Unsubscribe","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique unsubscribe record ID"},"email":{"type":"string","format":"email","description":"Unsubscribed email address"},"source":{"type":"string","enum":["link","one-click","api","manual"],"description":"How the unsubscribe occurred"},"reason":{"type":"string","description":"Reason for unsubscribe"},"created_at":{"type":"string","format":"date-time","description":"When the unsubscribe occurred"}}}},"components/schemas/EmailValidationResult":{"id":"components/schemas/EmailValidationResult","kind":"json-schema","title":"EmailValidationResult","data":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email address that was validated"},"is_valid":{"type":"boolean","description":"Whether the email address is valid and deliverable"},"validation_checks":{"type":"object","description":"Detailed validation check results","properties":{"syntax_valid":{"type":"boolean","description":"Whether email syntax is valid (RFC 5322)"},"domain_exists":{"type":"boolean","description":"Whether the domain exists (DNS lookup)"},"has_mx_records":{"type":"boolean","description":"Whether domain has MX records configured"},"is_disposable":{"type":"boolean","description":"Whether domain is a disposable/temporary email service"},"disposable_source":{"type":"string","description":"Source that identified disposable domain (if applicable)","example":"multiple_sources"},"disposable_confidence":{"type":"integer","minimum":0,"maximum":100,"description":"Confidence score for disposable detection (0-100)"},"is_role_account":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether email is a role account (admin@, support@, etc.)"},"children":[]}]}]}]},"is_free_provider":{"type":"boolean","description":"Whether domain is a free email provider (Gmail, Yahoo, etc.)"},"mailbox_exists":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of SMTP mailbox probe (RCPT TO check)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — mail server confirmed the mailbox exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — mail server rejected the address (550/551/553 etc.) — mailbox does not exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — inconclusive (catch-all domain, server timeout, connection refused, or SMTP probe skipped)"},"children":[]}]}]}]}],"example":true},"is_catch_all":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the domain is a catch-all (accepts mail to any address, real or not)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailbox_exists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because individual mailboxes cannot be verified."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the check was skipped (e.g. domain has no MX records or is disposable)"},"children":[]}]}]}]}],"example":false},"smtp_check_performed":{"type":"boolean","description":"Whether the SMTP mailbox probe was executed. It is skipped for disposable domains\nand domains with no MX records since those are already marked invalid.\n","example":true},"smtp_reason":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional context from the SMTP probe when the mailbox was rejected or the check"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was inconclusive. Omitted when the mailbox was confirmed ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailbox_exists: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"User unknown"}}},"risk_level":{"type":"string","enum":["low","medium","high"],"description":"Overall risk assessment"},"deliverability_score":{"type":"integer","minimum":0,"maximum":100,"description":"Deliverability score (0-100, higher is better). Inverse of risk score with capped overrides for disposable/no-MX cases."},"confidence_score":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deliverability confidence score (0–100). Distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliverability_score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this reflects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"how certain we are the email will actually reach an inbox, incorporating:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP mailbox probe result"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catch-all domain detection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MX provider reputation (Google Workspace, Microsoft 365, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address pattern (human name vs. random string vs. role)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP response latency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Higher = more confident the address is genuinely deliverable."},"children":[]}]}]}]}],"example":72},"confidence_label":{"type":"string","nullable":true,"enum":["very_high","high","medium","low","very_low"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable confidence tier derived from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"confidence_score"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"very_high"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (90–100) — mailbox confirmed, reputable provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"high"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (70–89) — strong signals, likely deliverable"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"medium"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (50–69) — catch-all or mild uncertainty"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"low"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (30–49) — significant uncertainty (unknown provider, inconclusive SMTP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"very_low"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (0–29) — likely undeliverable"},"children":[]}]}]}]}],"example":"high"},"mx_provider":{"type":"object","nullable":true,"description":"Detected MX mail provider for the domain.","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider key (e.g. google, microsoft, amazon_ses, zoho, custom)"},"children":[]}]}]}],"example":"google"},"tier":{"type":"string","enum":["enterprise","reputable","unknown","none"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider reputation tier used in confidence scoring."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enterprise"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Google Workspace, Microsoft 365, Mimecast, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reputable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Zoho, Fastmail, SendGrid, Yahoo, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Custom or unrecognised mail server"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — No MX records found"},"children":[]}]}]}]}],"example":"enterprise"}}},"email_pattern":{"type":"string","nullable":true,"enum":["human_name","role","random","generic"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classified pattern of the email local part (before @):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"human_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — looks like firstname.lastname or similar personal address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"role"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — generic role address (info@, admin@, support@, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"random"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — high-entropy / randomly generated string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — does not clearly match other categories"},"children":[]}]}]}]}],"example":"human_name"},"suggestions":{"type":"array","items":{"type":"string"},"description":"Informational notes or suggestions (e.g. catch-all notice, role account notice)","example":["Catch-all domain detected with a reputable mail provider. Email may be deliverable but cannot be individually verified."]},"reason":{"type":"string","description":"Reason if email is invalid or undeliverable","example":"Disposable email service detected"},"usage":{"type":"object","description":"Validation quota usage information","properties":{"used":{"type":"integer","description":"Validations used this period"},"limit":{"type":"integer","description":"Total validation limit"},"remaining":{"type":"integer","description":"Remaining validations"}}}}}},"components/schemas/HealthScore":{"id":"components/schemas/HealthScore","kind":"json-schema","title":"HealthScore","data":{"type":"object","properties":{"overall_score":{"type":"number","minimum":0,"maximum":100,"description":"Overall health score (0-100, higher is better)"},"delivery_rate":{"type":"number","description":"Percentage of emails successfully delivered"},"open_rate":{"type":"number","description":"Percentage of delivered emails opened"},"click_rate":{"type":"number","description":"Percentage of delivered emails clicked"},"bounce_rate":{"type":"number","description":"Percentage of emails bounced"},"complaint_rate":{"type":"number","description":"Percentage of emails marked as spam"},"reputation_grade":{"type":"string","enum":["A+","A","B+","B","C+","C","D","F"],"description":"Letter grade representation of health score"},"last_calculated":{"type":"string","format":"date-time","description":"When this score was last calculated"}}}},"components/schemas/Pagination":{"id":"components/schemas/Pagination","kind":"json-schema","title":"Pagination","data":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer","description":"Total number of items"},"pages":{"type":"integer","description":"Total number of pages"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message"},"code":{"type":"string","description":"Stable machine-readable error code when available","example":"VALIDATION_ERROR"},"details":{"type":"object","description":"Optional structured details about the error","additionalProperties":true},"request_id":{"type":"string","description":"Request identifier for support. Also returned in the X-Request-ID response header.","example":"9xexpc"}}}},"components/schemas/SMTPCredential":{"id":"components/schemas/SMTPCredential","kind":"json-schema","title":"SMTPCredential","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique credential identifier"},"name":{"type":"string","description":"Human-readable label for this credential set","example":"Marketing Automation"},"username":{"type":"string","description":"Auto-generated SMTP username. New credentials use a privacy-safe random format and do not include customer names or email local parts.","example":"ml_smtp_1f2961f48a99c8e2"},"status":{"type":"string","enum":["active","disabled"],"description":"Whether this credential is active"},"is_master":{"type":"boolean","description":"Whether this is the original/primary credential for the account"},"sending_domain_id":{"type":"string","format":"uuid","nullable":true,"description":"Optional sending domain restriction. If set, emails sent with this credential must use this domain in the From address."},"sending_domain":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain name associated with sending_domain_id"},"children":[]}]}]}],"example":"marketing.example.com"},"smtp_hostname_id":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom SMTP hostname this credential is bound to. When set, this credential"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can only authenticate via that specific hostname. Null means the credential is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bound to the default endpoint only (unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_master: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"works on all hostnames)."},"children":[]}]}]}]},"daily_limit":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum emails per day (null = unlimited)"},"children":[]}]}]}]},"monthly_limit":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum emails per month (null = unlimited)"},"children":[]}]}]}]},"daily_sent":{"type":"integer","description":"Emails sent today (resets at midnight UTC)","default":0},"monthly_sent":{"type":"integer","description":"Emails sent this month (resets on 1st of month UTC)","default":0},"last_used_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp of most recent SMTP authentication with this credential"},"created_at":{"type":"string","format":"date-time"}}}},"components/schemas/SMTPHostname":{"id":"components/schemas/SMTPHostname","kind":"json-schema","title":"SMTPHostname","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique hostname identifier"},"hostname":{"type":"string","description":"The custom SMTP hostname customers use in their mail client (e.g. smtp.yourbrand.com)","example":"smtp.yourbrand.com"},"sending_domain_id":{"type":"string","format":"uuid","nullable":true,"description":"Optional sending domain restriction associated with this hostname. Emails via this hostname must use this domain in the From address."},"sending_domain":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain name associated with sending_domain_id"},"children":[]}]}]}],"example":"yourbrand.com"},"dns_verified":{"type":"boolean","description":"Whether the CNAME DNS record pointing to the mail server has been verified"},"ssl_status":{"type":"string","enum":["pending","issued","failed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the TLS certificate for this hostname."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certificate not yet issued (DNS must be verified first)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certificate successfully issued and loaded via SNI"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Certificate issuance failed (check DNS records)"},"children":[]}]}]}]}]},"status":{"type":"string","enum":["active","disabled"],"description":"Whether this custom hostname is active"},"verified_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when DNS verification was last confirmed"},"ssl_issued_at":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when the TLS certificate was successfully issued"},"created_at":{"type":"string","format":"date-time"},"dns_instructions":{"type":"object","description":"DNS records the customer must configure (returned only on create/verify calls)","properties":{"cname":{"type":"object","properties":{"type":{"type":"string","example":"CNAME"},"name":{"type":"string","example":"smtp.yourbrand.com"},"value":{"type":"string","example":"smtp.mailerlogic.net"},"ttl":{"type":"integer","example":300}}}}}}}},"schema_221":{"kind":"json-schema","data":{"type":"string","maxLength":255},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"type":"object","required":["to","subject"],"properties":{"domain":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending domain. Optional when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided; otherwise auto-selects the first verified domain."},"children":[]}]}]}],"example":"mail.yourdomain.com"},"from":{"oneOf":[{"type":"string","format":"email","example":"hello@mail.yourdomain.com"},{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"hello@mail.yourdomain.com"},"name":{"type":"string","example":"Your Company"}}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From email address, or an object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to noreply@domain when omitted."},"children":[]}]}]}]},"from_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name for the sender when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a string. Ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}],"example":"Your Company"},"to":{"type":"string","format":"email","description":"Recipient email address","example":"user@example.com"},"reply_to":{"type":"string","format":"email","description":"Reply-to email address","example":"support@yourdomain.com"},"cc":{"type":"array","items":{"type":"string","format":"email"},"description":"CC recipients","example":["manager@example.com"]},"bcc":{"type":"array","items":{"type":"string","format":"email"},"description":"BCC recipients (hidden from other recipients)","example":["archive@yourdomain.com"]},"subject":{"type":"string","description":"Email subject line","example":"Welcome to our platform!"},"preview_text":{"type":"string","description":"Preview/preheader text shown in email clients next to subject (40-130 characters recommended).\nAppears in inbox list view before opening the email. Also called \"preheader text\".\n","example":"Get started with your account in just a few clicks"},"html":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTML email body. Supports dynamic placeholders:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in Placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Automatically replaced with secure unsubscribe link"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"<p>Don't want emails? <a href=\"{{unsubscribe}}\">Unsubscribe</a></p>\n","language":"html"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"<p>Don't want emails? <a href=\"{{unsubscribe}}\">Unsubscribe</a></p>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system automatically:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with unique, secure URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds List-Unsubscribe headers for one-click unsubscribe"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracks unsubscribes per domain"},"children":[]}]}]}]}],"example":"<h1>Welcome!</h1><p>Thanks for signing up.</p><p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plain text email body (fallback for non-HTML clients). Supports the same placeholders as HTML:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Built-in Placeholders:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{unsubscribe}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Automatically replaced with secure unsubscribe link"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Unsubscribe: {{unsubscribe}}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unsubscribe: {{unsubscribe}}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-generation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the platform automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generates a clean plain-text version from your HTML before sending. The email is then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivered as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/alternative"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (text/plain + text/html), which improves"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliverability and avoids spam filter penalties for HTML-only messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing your own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is still recommended for full control over accessibility"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and plain-text client rendering."},"children":[]}]}]}],"example":"Welcome! Thanks for signing up.\n\nUnsubscribe: {{unsubscribe}}"},"track_opens":{"type":"boolean","description":"Enable open tracking (default: account setting)","example":true},"track_clicks":{"type":"boolean","description":"Enable click tracking (default: account setting)","example":true},"headers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom email headers for the message."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add custom headers like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Order-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-User-ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reply-To"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add tracking or reference headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store structured data as JSON string"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook support:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers are included in webhook payloads alongside metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Headers are sent with the email and included in webhooks. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for data that should NOT be sent in the email."},"children":[]}]}]}],"additionalProperties":true,"example":{"X-Campaign-ID":"campaign-123","X-User-ID":"user-456","Reply-To":"support@example.com"}},"tag":{"type":"string","description":"Tag for organizing emails (for analytics, not routing)","example":"welcome-series"},"stream_type":{"type":"string","enum":["transactional","broadcast","shared"],"default":"transactional","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP stream type for routing (default: transactional)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": High-priority emails (passwords, confirmations, receipts)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Marketing campaigns and newsletters (receives campaign-level bounce monitoring)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": General purpose emails"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign Tracking:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Emails with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_type: broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are automatically grouped into campaign sessions for bounce rate monitoring and auto-pause protection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declaring "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an IP-pool bypass. Repeated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bulk-like use of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/send"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be routed as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; inspect"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_reclassified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response."},"children":[]}]}]}],"example":"transactional"},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom metadata (stored in database, NOT sent in email)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link emails to orders, users, or resources in your system"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track campaign performance and ROI"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store application-specific context"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter and analyze emails by custom attributes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass through data to your webhook handlers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook support:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Metadata is included in all webhook events (delivered, bounced, opened, clicked, complained, unsubscribed)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Difference from headers:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Metadata is never sent in the email, while headers are included in the email message."},"children":[]}]}]}],"additionalProperties":true,"example":{"user_id":"12345","order_id":"ord_789","campaign":"summer_sale","tier":"premium"}},"attachments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File attachments (PDF, ZIP, images, documents)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Attachments are sent directly through SMTP without storing on server."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64 encode your files and include them in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max per file: 10 MB (configurable)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max total size: 25 MB (including HTML)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported: All file types"},"children":[]}]}]}]}],"items":{"type":"object","required":["filename","content","contentType"],"properties":{"filename":{"type":"string","description":"Display name for the attachment","example":"invoice-12345.pdf"},"content":{"type":"string","format":"byte","description":"Base64 encoded file content","example":"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL..."},"contentType":{"type":"string","description":"MIME type of the file","example":"application/pdf"},"encoding":{"type":"string","description":"Content encoding (default is base64)","default":"base64","example":"base64"}}},"example":[{"filename":"invoice.pdf","content":"JVBERi0xLjQK...","contentType":"application/pdf"},{"filename":"report.csv","content":"TmFtZSxFbWFpbC...","contentType":"text/csv"}]},"icalEvent":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"iCal calendar event in RFC 5545 format for meeting invites."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Native calendar support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - works with Gmail, Outlook, Apple Mail:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gmail: Shows \"Add to Calendar\" button"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outlook: Shows Accept/Decline/Tentative buttons"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Mail: Shows \"Add to Calendar\" button"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implementation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Sends as both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/calendar"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" MIME alternative"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AND "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite.ics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attachment for maximum compatibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Event is sent directly, not stored on server."},"children":[]}]}]}],"example":"BEGIN:VCALENDAR\nVERSION:2.0\nPRODID:-//YourApp//Calendar//EN\nMETHOD:REQUEST\nCALSCALE:GREGORIAN\nBEGIN:VEVENT\nUID:meeting-123@yourdomain.com\nDTSTAMP:20250127T120000Z\nDTSTART:20250128T140000Z\nDTEND:20250128T150000Z\nSUMMARY:Team Meeting\nDESCRIPTION:Discuss Q1 goals\nLOCATION:Conference Room A\nORGANIZER;CN=Manager:mailto:manager@yourdomain.com\nATTENDEE;CN=Employee;RSVP=TRUE:mailto:employee@example.com\nSTATUS:CONFIRMED\nSEQUENCE:0\nBEGIN:VALARM\nTRIGGER:-PT15M\nACTION:DISPLAY\nDESCRIPTION:Reminder\nEND:VALARM\nEND:VEVENT\nEND:VCALENDAR\n"}}},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"type":"object","properties":{"to":{"type":"string","format":"email","description":"Recipient email address","example":"user@example.com"},"submitted_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when email was queued","example":"2024-01-15T10:30:00Z"},"message_id":{"type":"string","description":"RFC 5322 Message-ID header value","example":"<650e8400-e29b-41d4-a716-446655440000@mail.yourdomain.com>"},"email_id":{"type":"string","format":"uuid","description":"Unique email ID for tracking","example":"650e8400-e29b-41d4-a716-446655440000"},"status":{"type":"string","enum":["queued"],"description":"Current email status"},"message":{"type":"string","description":"Success message"},"stream_type":{"type":"string","enum":["transactional","broadcast","shared"],"description":"Effective stream used for queue and IP routing."},"stream_reclassified":{"type":"boolean","description":"True when MailerLogic changed the requested stream based on sending behavior."},"stream_reclassification_reason":{"type":"string","nullable":true,"example":"bulk_like_transactional_pattern"}}},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}}},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"}}},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"object","required":["emails"],"properties":{"campaign_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" campaign identifier for grouping related emails and tracking bounce rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-pause protection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If bounce rate exceeds thresholds, the campaign will be automatically paused to protect IP reputation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best practice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Provide this when sending related batches (e.g., \"daily-digest\", \"order-notifications-batch\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, system auto-generates: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batch-{timestamp}-{customer_id}"},"children":[]}]}]}],"example":"order-confirmations-batch-2026-02-27"},"emails":{"type":"array","description":"Array of emails to send (max 500)","maxItems":500,"items":{"type":"object","required":["to","subject"],"properties":{"to":{"type":"string","format":"email","description":"Recipient email address","example":"user@example.com"},"from":{"type":"string","format":"email","description":"From email (must use verified domain, optional)","example":"hello@mail.yourdomain.com"},"from_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name for the sender (appears as \"From Name "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"email","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\")"},"children":[]},{"$$mdtype":"Node","type":"error","inline":true,"errors":[{"id":"parse-error","level":"critical","message":"HTML tag <email> is not closed, opened at"}],"attributes":{},"children":[]}]}]}]}],"example":"Your Company"},"domain":{"type":"string","description":"Sending domain (optional - auto-selects if omitted)","example":"mail.yourdomain.com"},"reply_to":{"type":"string","format":"email","description":"Reply-to address","example":"support@yourdomain.com"},"cc":{"type":"array","items":{"type":"string","format":"email"},"description":"CC recipients"},"bcc":{"type":"array","items":{"type":"string","format":"email"},"description":"BCC recipients"},"subject":{"type":"string","description":"Email subject","example":"Your order has shipped"},"html":{"type":"string","description":"HTML email body","example":"<h1>Order shipped!</h1>"},"text":{"type":"string","description":"Plain text body","example":"Your order has shipped"},"track_opens":{"type":"boolean","description":"Enable open tracking"},"track_clicks":{"type":"boolean","description":"Enable click tracking"},"headers":{"type":"object","description":"Custom headers"},"tag":{"type":"string","description":"Tag for organizing"},"metadata":{"type":"object"},"attachments":{"type":"array","description":"File attachments (sent directly, not stored)","items":{"type":"object","required":["filename","content","contentType"],"properties":{"filename":{"type":"string","example":"invoice.pdf"},"content":{"type":"string","format":"byte","description":"Base64 encoded content"},"contentType":{"type":"string","example":"application/pdf"}}}},"icalEvent":{"type":"string","description":"iCal calendar event in RFC 5545 format (sent directly, not stored)"},"stream_type":{"type":"string","enum":["transactional","broadcast","shared"],"default":"shared","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream type for delivery optimization:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactional"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order confirmations, password resets, account notifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Marketing emails, newsletters, promotional campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shared"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": General purpose (default)"},"children":[]}]}]}]}]}}}}}},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"type":"object","properties":{"total":{"type":"integer","description":"Total emails in batch"},"queued":{"type":"integer","description":"Successfully queued emails"},"failed":{"type":"integer","description":"Failed emails"},"results":{"type":"array","description":"Successfully queued emails","items":{"type":"object","properties":{"index":{"type":"integer","description":"Index in original array"},"to":{"type":"string","format":"email","description":"Recipient"},"email_id":{"type":"string","format":"uuid","description":"Email ID for tracking"},"message_id":{"type":"string","description":"Message-ID header"},"status":{"type":"string","enum":["queued"]}}}},"errors":{"type":"array","description":"Failed emails (only if any failed)","items":{"type":"object","properties":{"index":{"type":"integer","description":"Index in original array"},"email":{"type":"string","description":"Email address or identifier"},"error":{"type":"string","description":"Error message"}}}}}},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","enum":["DAILY_LIMIT_EXCEEDED","BATCH_EXCEEDS_MONTHLY_LIMIT"]},"message":{"type":"string"},"batch_size":{"type":"integer"},"daily_limit":{"type":"integer"},"monthly_limit":{"type":"integer"},"reserved_today":{"type":"integer"},"reserved_this_month":{"type":"integer"}}},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"type":"object","required":["subject","recipients"],"properties":{"campaign_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" campaign identifier for grouping related emails and tracking bounce rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-pause protection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If bounce rate exceeds thresholds, the campaign will be automatically paused to protect IP reputation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How Campaign Grouping Works:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All emails with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group into ONE campaign session"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce rates are calculated across the entire group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-pause applies to ALL future sends using this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign reports aggregate all metrics together"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ CRITICAL: Each campaign MUST use a UNIQUE campaign_id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use unique IDs per campaign send"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"monthly-newsletter-2026-03-05\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"spring-sale-2026-week1\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"product-launch-v2-2026-03\""},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DON'T"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reuse campaign_id across different campaigns"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"newsletter\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (reused every month)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"promo\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (reused for all promos)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"bulk-send\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (too generic)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why This Matters:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you reuse a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce rates from OLD campaigns affect NEW campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New campaign might be immediately paused due to old bounces"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign reports mix data from different time periods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot track individual campaign performance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended Format:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{campaign-name}-{date}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{campaign-name}-{version}-{date}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly newsletters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"newsletter-2026-03\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"newsletter-2026-04\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales campaigns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"spring-sale-2026-w1\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"spring-sale-2026-w2\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product launches: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"product-x-launch-2026-03-05\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, system auto-generates: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk-{timestamp}-{customer_id}"},"children":[]}]}]}],"example":"spring-sale-2026-march"},"subject":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email subject with optional variables like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{name}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{code}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If using personalization, also provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject_template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for proper campaign tracking."},"children":[]}]}]}],"example":"Hello {{name}}! Your code is {{code}}"},"subject_template":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when using personalized subjects. The template before variable substitution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why needed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Helps system track campaigns correctly when subjects are personalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject_template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"Hello {{name}}! Your code is {{code}}\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each recipient: \"Hello John! Your code is SAVE20\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, system normalizes the subject automatically (less accurate)."},"children":[]}]}]}],"example":"Hello {{name}}! Your code is {{code}}"},"preview_text":{"type":"string","description":"Preview/preheader text shown in email clients next to subject (40-130 characters recommended).\nAppears in inbox list view before opening the email.\n","example":"Exclusive offer just for you - save 20% today!"},"html":{"type":"string","description":"HTML email body with variables","example":"<h1>Hi {{name}}</h1><p>Your discount code: {{code}}</p>"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plain text email body with variables. Supports the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{variable}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" merge fields as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-generation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If omitted, a plain-text version is automatically generated from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before sending. Supplying your own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is recommended for best plain-text"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client rendering."},"children":[]}]}]}],"example":"Hi {{name}}, Your discount code: {{code}}"},"from":{"type":"string","format":"email","description":"From email (must use verified domain, optional)","example":"hello@mail.yourdomain.com"},"from_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name for the sender (appears as \"From Name "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"email","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\")"},"children":[]},{"$$mdtype":"Node","type":"error","inline":true,"errors":[{"id":"parse-error","level":"critical","message":"HTML tag <email> is not closed, opened at"}],"attributes":{},"children":[]}]}]}]}],"example":"Your Company"},"domain":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending domain (optional - auto-extracted from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" email if not provided)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If provided, must match the domain in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" email address."},"children":[]}]}]}],"example":"mail.yourdomain.com"},"reply_to":{"type":"string","format":"email","description":"Reply-to address","example":"support@yourdomain.com"},"track_opens":{"type":"boolean","description":"Enable open tracking (default: true)","default":true},"track_clicks":{"type":"boolean","description":"Enable click tracking (default: true)","default":true},"tag":{"type":"string","description":"Tag for organizing/filtering emails","example":"newsletter-2025-12"},"stream_type":{"type":"string","enum":["broadcast"],"default":"broadcast","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream type is locked to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"broadcast"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for bulk sending."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk/mail merge emails are marketing/newsletter content and must use the broadcast stream to protect transactional IP reputation."},"children":[]}]}]}]},"attachments":{"type":"array","description":"File attachments sent with every email (sent directly, not stored).\nSame attachments sent to all recipients.\n","items":{"type":"object","required":["filename","content","contentType"],"properties":{"filename":{"type":"string","example":"newsletter.pdf"},"content":{"type":"string","format":"byte","description":"Base64 encoded content"},"contentType":{"type":"string","example":"application/pdf"}}}},"icalEvent":{"type":"string","description":"iCal calendar event in RFC 5545 format (sent directly, not stored).\nSame calendar invite sent to all recipients.\n"},"recipients":{"type":"array","description":"Array of recipients with personalization variables","items":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"Recipient email address","example":"user@example.com"},"vars":{"type":"object","description":"Variables for this recipient","example":{"name":"John Doe","code":"SAVE20","product":"Premium Plan"}}}}}},"example":{"campaign_id":"spring-sale-2026-discount-20","subject":"Hello {{name}}! Special offer inside","subject_template":"Hello {{name}}! Special offer inside","preview_text":"Exclusive discount code just for you - save 20% today!","html":"<h1>Hi {{name}}</h1><p>Use code <strong>{{code}}</strong> for 20% off!</p><p><a href=\"{{unsubscribe}}\">Unsubscribe</a></p>","text":"Hi {{name}}, Use code {{code}} for 20% off!\n\nUnsubscribe: {{unsubscribe}}","from":"hello@mail.yourdomain.com","from_name":"Your Company","track_opens":true,"track_clicks":true,"tag":"holiday-sale-2025","stream_type":"broadcast","recipients":[{"email":"john@example.com","vars":{"name":"John","code":"JOHN20"}},{"email":"jane@example.com","vars":{"name":"Jane","code":"JANE20"}}]}},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Emails queued for delivery"},"queued":{"type":"integer","description":"Number of emails successfully queued","example":2},"errors":{"type":"integer","description":"Number of emails that failed to queue","example":0},"campaign_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign tracking UUID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Use this ID to query campaign reports via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/campaign-reports/{campaign_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk_session_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that groups all emails in this campaign together for analytics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Save this ID to track campaign performance, bounce rates, opens, and clicks."},"children":[]}]}]}],"example":"f1e2d3c4-b5a6-7890-cdef-123456789abc"},"bulk_session_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias for campaign_id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Same UUID, different name for backwards compatibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bulk_session_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reference the same campaign session."},"children":[]}]}]}],"example":"f1e2d3c4-b5a6-7890-cdef-123456789abc"},"jobs":{"type":"array","description":"Array of queued email jobs with tracking information","items":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Recipient email address"},"jobId":{"type":"string","description":"Queue job ID for this specific email"},"emailId":{"type":"string","format":"uuid","description":"Database email record ID"},"campaignId":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign session UUID (same as top-level campaign_id)"},"children":[]}]}]}]}}}},"error_details":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of errors for failed recipients (only included if errors > 0)"},"children":[]}]}]}],"items":{"type":"object","properties":{"recipient":{"type":"string","format":"email"},"error":{"type":"string"}}}}}},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"}}},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"type":"object","required":["subject","html","from"],"properties":{"campaign_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" campaign identifier for grouping related emails and tracking bounce rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-pause protection:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If bounce rate exceeds thresholds, the campaign will be automatically paused to protect IP reputation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How Campaign Grouping Works:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All emails with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group into ONE campaign session"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce rates are calculated across the entire group"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-pause applies to ALL future sends using this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign reports aggregate all metrics together"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ CRITICAL: Each campaign MUST use a UNIQUE campaign_id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DO"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use unique IDs per campaign send"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"monthly-newsletter-2026-03\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"vip-flash-sale-2026-week12\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Good: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"product-update-v3-2026-03-05\""},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DON'T"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reuse campaign_id across different campaigns"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"newsletter\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (reused every month)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"segment-send\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (too generic)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"promo\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (reused for all promos)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why This Matters:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you reuse a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaign_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bounce rates from OLD campaigns affect NEW campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New campaign might be immediately paused due to old bounces"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign reports mix data from different time periods"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot track individual campaign performance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended Format:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{campaign-name}-{date}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{campaign-name}-{version}-{date}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly newsletters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"newsletter-2026-03\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"newsletter-2026-04\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VIP promotions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"vip-sale-2026-w1\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"vip-sale-2026-w2\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment campaigns: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"re-engagement-inactive-2026-q1\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, system auto-generates: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"segment-{segment_id}-{timestamp}"},"children":[]}]}]}],"example":"monthly-newsletter-2026-march"},"segment_id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of saved segment (use this OR segment_filters, not both)"},"children":[]}]}]}],"example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"segment_filters":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inline segment filters (use this OR segment_id, not both)"},"children":[]}]}]}],"properties":{"match_type":{"type":"string","enum":["all","any"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all=AND logic, any=OR logic"},"children":[]}]}]}],"default":"all"},"filter_conditions":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string","example":"status"},"operator":{"type":"string","enum":["equals","not_equals","contains","not_contains","greater_than","less_than","greater_than_or_equal","less_than_or_equal","is_empty","is_not_empty","is_true","is_false"],"example":"equals"},"value":{"description":"Value to compare (type depends on property)","example":"subscribed"}}}}}},"subject":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email subject with merge field support."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If using personalization, also provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject_template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for proper campaign tracking and bounce grouping."},"children":[]}]}]}],"example":"Hello {{first_name}}!"},"subject_template":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when using personalized subjects. The template before variable substitution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why needed:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Helps system track campaigns correctly when subjects are personalized. Without this, emails with different personalized subjects (e.g., \"Hello John\" vs \"Hello Mary\") are treated as separate campaigns, breaking bounce rate tracking."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign Grouping:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With subject_template"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All emails group into ONE campaign"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Each personalized subject creates a separate campaign"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject_template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"Hello {{first_name}}! Special offer inside\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for John: \"Hello John! Special offer inside\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Mary: \"Hello Mary! Special offer inside\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result: Both emails tracked together under the same campaign"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, system normalizes the subject automatically (less accurate)."},"children":[]}]}]}],"example":"Hello {{first_name}}! Special offer inside"},"preview_text":{"type":"string","description":"Preview text shown in email clients (40-130 chars recommended)","example":"Exclusive offer just for you"},"html":{"type":"string","description":"HTML email body with merge field support","example":"<h1>Hi {{name}}</h1><p>Use code {{promo_code}}</p>"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plain text email body with merge field support. Supports the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{variable}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" syntax as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-generation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If omitted, a plain-text version is automatically generated from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before sending. Supplying your own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is recommended for best plain-text"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client rendering."},"children":[]}]}]}],"example":"Hi {{name}}, Use code {{promo_code}}"},"from":{"type":"string","format":"email","description":"From email address (must use verified domain)","example":"hello@mail.yourdomain.com"},"from_name":{"type":"string","description":"Display name for sender","example":"Your Company"},"track_opens":{"type":"boolean","description":"Enable open tracking","default":false},"track_clicks":{"type":"boolean","description":"Enable click tracking","default":false},"tag":{"type":"string","description":"Tag for organizing/filtering this campaign","example":"newsletter-2025-02"},"stream_type":{"type":"string","enum":["broadcast"],"default":"broadcast","description":"Stream type (locked to broadcast for segment sending)"},"account_merge_fields":{"type":"object","description":"Account-level merge fields (same value for all recipients)","example":{"promo_code":"SAVE20","company_name":"Acme Corp","unsubscribe_url":"https://example.com/unsubscribe"}},"exclude_unengaged":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW: Exclude unengaged contacts from this campaign"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unengaged contact is one who hasn't opened or clicked ANY email"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the last N days (specified by unengaged_days parameter)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Benefits:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Improves sender reputation by avoiding inactive contacts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reduces costs by not sending to non-responders"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Increases campaign engagement metrics (higher open/click rates)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use 90 days for regular newsletters (recommended)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use 30 days for time-sensitive promotions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use 180+ days for re-engagement campaigns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable (false) for transactional emails"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Use Cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly newsletter → exclude_unengaged: true, unengaged_days: 90"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flash sale → exclude_unengaged: true, unengaged_days: 30"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Win-back campaign → exclude_unengaged: false (send to all)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Password reset → exclude_unengaged: false (transactional)"},"children":[]}]}]}]}],"example":true},"unengaged_days":{"type":"integer","enum":[30,60,90,180,365],"default":90,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of days to look back when determining engagement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only used if exclude_unengaged is true."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A contact is considered \"engaged\" if they opened or clicked"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any email from your account in the last N days."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended values:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Aggressive filtering, very active users only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Moderately active users"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"90 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Standard (recommended for most campaigns)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"180 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Conservative, includes less frequent engagers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"365 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Very conservative, annual engagement check"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Impact on List Size:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typical engagement rates:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30 days: ~40-60% of list (most aggressive)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"90 days: ~60-80% of list (balanced)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"180 days: ~70-90% of list (conservative)"},"children":[]}]}]}]}],"example":90}}},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"Segment email queued for delivery"},"job_id":{"type":"string","format":"uuid","description":"Background job ID for tracking","example":"f1e2d3c4-b5a6-7890-cdef-123456789abc"},"status":{"type":"string","example":"processing"}}},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","examples":["Must provide either segment_id or segment_filters","Missing required fields: subject, html, and from are required","Domain mail.yourdomain.com is not verified. Please verify DKIM records first.","Segment filters exceed complexity limits"]},"details":{"type":"array","description":"Validation error details (if applicable)"},"limits":{"type":"object","description":"Complexity limits (if exceeded)","properties":{"MAX_GROUPS":{"type":"integer","example":10},"MAX_FILTERS_PER_GROUP":{"type":"integer","example":20},"MAX_TOTAL_FILTERS":{"type":"integer","example":100}}}}},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-ID":{"type":"string","description":"Request identifier for support"}}},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Segment not found"}}},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"object","required":["domain_id","from","to"],"properties":{"domain_id":{"type":"string","format":"uuid","description":"Domain ID"},"from":{"type":"string","format":"email","description":"From email address"},"to":{"type":"string","format":"email","description":"To email address"},"subject":{"type":"string","description":"Email subject (default \"Test Email\")"},"html":{"type":"string","description":"HTML content"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plain text email body. If omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, a plain-text version is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically generated from the HTML before sending."},"children":[]}]}]}]},"track_opens":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable open tracking (overridden by test_mode)"},"children":[]}]}]}]},"track_clicks":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable click tracking (overridden by test_mode)"},"children":[]}]}]}]},"test_mode":{"type":"string","enum":["basic","standard","full"],"description":"Test mode to use (recommended from test-readiness API)"},"analyze_content":{"type":"boolean","default":true,"description":"Run basic spam word detection (not full content scoring)"}}},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"email":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"from":{"type":"string"},"to":{"type":"string"},"subject":{"type":"string"},"domain":{"type":"string"},"message_id":{"type":"string"},"status":{"type":"string"},"tracking":{"type":"object","properties":{"opens":{"type":"boolean"},"clicks":{"type":"boolean"}}}}},"domain_info":{"type":"object","properties":{"age_in_days":{"type":"integer"},"has_custom_tracking":{"type":"boolean"}}},"warnings":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"severity":{"type":"string"},"message":{"type":"string"},"recommendation":{"type":"string"}}}},"content_analysis":{"type":"object","nullable":true,"description":"Basic spam detection results (not comprehensive scoring)","properties":{"basic_check_performed":{"type":"boolean","description":"Indicates basic spam check was performed"},"spam_words_found":{"type":"integer","description":"Number of common spam phrases detected"},"note":{"type":"string","description":"Information about using full content scoring endpoint"}}},"next_steps":{"type":"array","items":{"type":"string"}}}},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"},"customer_status":{"type":"object","properties":{"suspended":{"type":"boolean"},"blocked":{"type":"boolean"}}}}},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"type":"object","required":["from","to","subject","html"],"properties":{"from":{"type":"string","format":"email","description":"Sender email address","example":"no-reply@yourdomain.com"},"to":{"type":"string","format":"email","description":"Test recipient (not actually sent)","example":"test@example.com"},"subject":{"type":"string","description":"Email subject line","example":"Weekly Newsletter - March 2026","maxLength":998},"html":{"type":"string","description":"HTML email content","example":"<html><body><h1>Hello!</h1><p>This is a test.</p></body></html>"},"text":{"type":"string","description":"Plain text version (optional)","example":"Hello! This is a test."}}},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"test_id":{"type":"string","format":"uuid","description":"Unique test identifier for tracking"},"overall_score":{"type":"integer","description":"Overall deliverability score (0-100, higher is better)","example":85},"grade":{"type":"string","enum":["excellent","good","fair","poor","critical"],"description":"Letter grade based on overall score","example":"good"},"spam_score":{"type":"object","description":"SpamAssassin spam scoring results","properties":{"score":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spam score (lower is better, aim for < 5.0)"},"children":[]}]}]}],"example":3.2},"threshold":{"type":"number","description":"Spam threshold (emails above this are marked as spam)","example":5},"is_spam":{"type":"boolean","description":"Whether email would be marked as spam","example":false},"tests_failed":{"type":"array","description":"List of failed spam tests","items":{"type":"object","properties":{"name":{"type":"string","example":"MISSING_HEADERS"},"score":{"type":"number","example":1.5},"description":{"type":"string","example":"Missing important email headers"}}}},"recommendations":{"type":"array","items":{"type":"string"},"example":["Add unsubscribe link","Balance text/image ratio"]}}},"blacklist_check":{"type":"object","description":"Blacklist status across major RBLs","properties":{"listed_count":{"type":"integer","description":"Number of blacklists where IP is listed","example":0},"total_checked":{"type":"integer","description":"Total number of blacklists checked","example":12},"is_clean":{"type":"boolean","description":"Whether IP is clean (not on any blacklists)","example":true},"results":{"type":"array","items":{"type":"object","properties":{"rbl":{"type":"string","example":"zen.spamhaus.org"},"listed":{"type":"boolean","example":false},"response_time_ms":{"type":"integer","example":45}}}}}},"link_safety":{"type":"object","description":"Link safety and validity check","properties":{"total_links":{"type":"integer","description":"Total number of links found","example":5},"safe_links":{"type":"integer","description":"Number of safe links","example":5},"suspicious_links":{"type":"integer","description":"Number of suspicious links","example":0},"broken_links":{"type":"integer","description":"Number of broken/unreachable links","example":0},"issues":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","example":"https://suspicious-site.com"},"issue":{"type":"string","example":"Redirect chain detected"},"severity":{"type":"string","enum":["warning","error","critical"],"example":"warning"}}}}}},"accessibility":{"type":"object","description":"Accessibility compliance check","properties":{"score":{"type":"integer","description":"Accessibility score (0-100)","example":90},"images_with_alt":{"type":"integer","description":"Number of images with alt text","example":3},"images_without_alt":{"type":"integer","description":"Number of images missing alt text","example":0},"has_semantic_html":{"type":"boolean","description":"Whether email uses semantic HTML","example":true},"issues":{"type":"array","items":{"type":"string"},"example":["Consider adding lang attribute to HTML tag"]}}},"content_analysis":{"type":"object","description":"Content quality analysis","properties":{"word_count":{"type":"integer","description":"Total word count","example":250},"has_unsubscribe_link":{"type":"boolean","description":"Whether email contains unsubscribe link","example":true},"text_to_image_ratio":{"type":"number","description":"Ratio of text to images","example":0.85},"has_excessive_links":{"type":"boolean","description":"Whether email has too many links","example":false},"readability_grade":{"type":"string","description":"Estimated reading level","example":"8th grade"}}},"recommendations":{"type":"array","description":"Overall recommendations to improve deliverability","items":{"type":"string"},"example":["Add alt text to all images","Include an unsubscribe link","Reduce spam score by fixing header issues"]},"tests_remaining":{"type":"integer","description":"Number of tests remaining this month for your tier","example":42},"tier_limit":{"type":"integer","description":"Monthly test limit for your tier","example":50}}},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Missing required field: html"}}},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Monthly deliverability test limit exceeded"},"limit":{"type":"integer","example":50},"used":{"type":"integer","example":50},"reset_date":{"type":"string","format":"date","example":"2026-04-01"}}},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"SpamAssassin service unavailable. Some checks may be incomplete."}}},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"type":"string","enum":["all","human_only","scanner_only"],"default":"all"},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"campaign_id":{"type":"string","format":"uuid","example":"f1e2d3c4-b5a6-7890-cdef-123456789abc"},"overview":{"type":"object","properties":{"total_sent":{"type":"integer","description":"Total emails sent in campaign","example":1085},"delivered":{"type":"integer","description":"Successfully delivered emails","example":1072},"bounced":{"type":"integer","description":"Permanent delivery failures (hard bounces)","example":8},"failed":{"type":"integer","description":"Temporary failures that exhausted retries","example":3},"deferred":{"type":"integer","description":"Currently retrying temporary failures","example":2},"hard_bounce":{"type":"integer","description":"Permanent delivery failures (same as bounced)","example":8},"soft_bounce":{"type":"integer","description":"Temporary delivery failures","example":5},"unique_opens":{"type":"integer","description":"Number of unique recipients who opened","example":363},"total_opens":{"type":"integer","description":"Total open count (includes multiple opens)","example":526},"unique_clicks":{"type":"integer","description":"Number of unique recipients who clicked","example":48},"total_clicks":{"type":"integer","description":"Total click count (includes multiple clicks)","example":59},"complaints":{"type":"integer","description":"Spam complaints","example":2},"unsubscribes":{"type":"integer","description":"Unsubscribe count","example":5},"delivery_rate":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of emails delivered (delivered/sent * 100)"},"children":[]}]}]}],"example":98.8},"open_rate":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of delivered emails opened (unique_opens/delivered * 100)"},"children":[]}]}]}],"example":33.86},"click_rate":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of delivered emails clicked (unique_clicks/delivered * 100)"},"children":[]}]}]}],"example":4.48},"click_to_open_rate":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of openers who clicked (unique_clicks/unique_opens * 100)"},"children":[]}]}]}],"example":13.22},"first_sent_at":{"type":"string","format":"date-time","description":"Timestamp of first email sent"},"last_sent_at":{"type":"string","format":"date-time","description":"Timestamp of last email sent"}}},"filter_applied":{"type":"string","description":"Filter applied to the data","example":"human_only"},"status_definitions":{"type":"object","description":"Explanation of email status values","properties":{"delivered":{"type":"string","example":"Successfully delivered to recipient"},"bounced":{"type":"string","example":"Permanent failure (5xx error, user unknown, etc.)"},"failed":{"type":"string","example":"Temporary failure exhausted retries (timeouts, throttling, etc.)"},"deferred":{"type":"string","example":"Currently retrying temporary failure"}}}}},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Campaign not found"}}},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"integer","default":100,"maximum":1000},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"contacts":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"john@example.com"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"company":{"type":"string","example":"Acme Corp"},"phone":{"type":"string","example":"+1234567890"},"first_opened_at":{"type":"string","format":"date-time","description":"Timestamp of first open"},"last_opened_at":{"type":"string","format":"date-time","description":"Timestamp of most recent open"},"open_count":{"type":"integer","description":"Total number of times this contact opened","example":3}}}},"total":{"type":"integer","description":"Total number of contacts who opened","example":363},"limit":{"type":"integer","example":100},"offset":{"type":"integer","example":0},"filter_applied":{"type":"string","example":"human_only"}}},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"contacts":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"phone":{"type":"string"},"first_clicked_at":{"type":"string","format":"date-time"},"last_clicked_at":{"type":"string","format":"date-time"},"click_count":{"type":"integer","example":2}}}},"total":{"type":"integer","example":48},"limit":{"type":"integer"},"offset":{"type":"integer"},"filter_applied":{"type":"string"}}},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"type":"string","enum":["hard","soft"]},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"type":"integer","default":100},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"contacts":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"bounce_type":{"type":"string","enum":["hard","soft"],"description":"Hard (permanent) or soft (temporary) bounce"},"bounce_reason":{"type":"string","description":"Detailed bounce reason from mail server"},"sent_at":{"type":"string","format":"date-time"},"bounced_at":{"type":"string","format":"date-time"}}}},"total":{"type":"integer"},"bounce_type_filter":{"type":"string"}}},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"contacts":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"failure_reason":{"type":"string","description":"Reason for delivery failure"},"sent_at":{"type":"string","format":"date-time"},"failed_at":{"type":"string","format":"date-time"}}}},"total":{"type":"integer"}}},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"string","enum":["delivered","bounced","pending","failed"]},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"type":"string"},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"object","properties":{"email_id":{"type":"string","format":"uuid"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"status":{"type":"string","enum":["delivered","bounced","pending","failed"]},"sent_at":{"type":"string","format":"date-time"},"delivered_at":{"type":"string","format":"date-time"},"opened_at":{"type":"string","format":"date-time"},"clicked_at":{"type":"string","format":"date-time"},"bounce_type":{"type":"string"},"bounce_reason":{"type":"string"},"unsubscribed_at":{"type":"string","format":"date-time"}}}},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}}},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"type":"string","enum":["hour","day"],"default":"hour"},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"timeline":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"Start of time bucket"},"total_opens":{"type":"integer","description":"Total opens in this time bucket (includes repeat opens)"},"unique_opens":{"type":"integer","description":"Unique recipients who opened in this time bucket"}}}},"precision":{"type":"string","example":"hour"},"filter_applied":{"type":"string","example":"human_only"}}},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"timeline":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"total_clicks":{"type":"integer"},"unique_clicks":{"type":"integer"}}}},"precision":{"type":"string"},"filter_applied":{"type":"string"}}},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"links":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The clicked URL","example":"https://example.com/product"},"total_clicks":{"type":"integer","description":"Total number of clicks (includes repeat clicks)","example":59},"unique_clicks":{"type":"integer","description":"Number of unique recipients who clicked","example":48},"unique_recipients":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Distinct count of recipients (same as unique_clicks)"},"children":[]}]}]}],"example":48}}}},"filter_applied":{"type":"string","example":"human_only"}}},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/CustomerProfile"}}},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"Customer account name","example":"Acme Corp"}}},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer"}}},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"API key rotated successfully. Update your applications with the new key immediately."},"api_key":{"type":"string","description":"New API key (v2 format with prefix)","example":"ml_live_8jKp3nXw7rQ9sL2mY4hT6vB1nC5xZ0aE8wD7gF3jH9kM2pN4q"},"key_prefix":{"type":"string","description":"First 8 characters of the key for identification","example":"ml_live_"},"customer":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"type":"string","format":"email"}}}}},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"object","properties":{"credentials":{"type":"array","items":{"$ref":"#/components/schemas/SMTPCredential"}},"smtp_host":{"type":"string","example":"smtp.mailerlogic.net"},"smtp_ports":{"type":"array","items":{"type":"integer"},"example":[587,465]},"recommended_port":{"type":"integer","example":587}}},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Friendly name for this credential","example":"Production Transactional"},"sending_domain_id":{"type":"string","format":"uuid","nullable":true,"description":"Optional. Restrict this credential to a specific verified sending domain."},"smtp_hostname_id":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. Bind this credential to a specific custom SMTP hostname (from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1/smtp-credentials/hostnames"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When set, this credential can only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be used to authenticate via that hostname. Credentials without a hostname"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"binding can only be used via the default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"smtp.mailerlogic.net"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_master"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true)."},"children":[]}]}]}]},"daily_limit":{"type":"integer","description":"Optional. Maximum emails per day for this credential.","example":5000},"monthly_limit":{"type":"integer","description":"Optional. Maximum emails per month for this credential.","example":100000}}},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"type":"object","properties":{"credential":{"$ref":"#/components/schemas/SMTPCredential"},"plain_password":{"type":"string","description":"The generated password. Shown once only.","example":"smtp_a1b2c3d4e5f6789..."}}},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"sending_domain_id":{"type":"string","format":"uuid","nullable":true,"description":"Set to null to remove the domain restriction."},"smtp_hostname_id":{"type":"string","format":"uuid","nullable":true,"description":"Set to null to unbind from a custom hostname. Set to a hostname ID to bind. Cannot be changed on a master credential."},"daily_limit":{"type":"integer","nullable":true},"monthly_limit":{"type":"integer","nullable":true}}},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"type":"object","properties":{"credential":{"$ref":"#/components/schemas/SMTPCredential"}}},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"type":"object","properties":{"credential_id":{"type":"string","format":"uuid"},"plain_password":{"type":"string","description":"New password. Shown once only."}}},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["active","disabled"]}}},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"type":"object","properties":{"hostnames":{"type":"array","items":{"$ref":"#/components/schemas/SMTPHostname"}}}},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","description":"The fully-qualified custom hostname","example":"smtp.yourdomain.com"},"sending_domain_id":{"type":"string","format":"uuid","nullable":true,"description":"Optional. Associate with a specific verified sending domain."}}},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"type":"object","properties":{"hostname":{"$ref":"#/components/schemas/SMTPHostname"},"dns_instructions":{"type":"object","properties":{"type":{"type":"string","example":"CNAME"},"name":{"type":"string","example":"smtp.yourdomain.com"},"value":{"type":"string","example":"smtp.mailerlogic.net"}}}}},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"type":"object","properties":{"verified":{"type":"boolean"},"hostname":{"type":"string"},"expected_cname":{"type":"string","example":"smtp.mailerlogic.net"},"message":{"type":"string"},"dns_error":{"type":"string","nullable":true}}},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"smtp_credentials":{"$ref":"#/components/schemas/SMTPCredentialsDetail"},"warning":{"type":"string","example":"Update your SMTP clients with the new password. The old password will no longer work."}}},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}}}},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","description":"Fully qualified domain name","pattern":"^[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,}$","example":"mail.acme.com"},"tags":{"type":"array","items":{"type":"string"},"description":"Optional tags for categorization","example":["production","transactional"]}}},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/DomainDetail"},"security_status":{"type":"string","enum":["pending_scan","active","under_review","suspended"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial security state of the new domain. Normally "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_scan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while the automated reputation scan runs; may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"under_review"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"suspended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" immediately if the domain has a prior security history."},"children":[]}]}]}]},"sending_allowed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"security_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","example":"Invalid domain name"}}},{"type":"object","properties":{"error":{"type":"string","example":"Domain limit reached. You have 5 of 5 domains."},"current_domains":{"type":"integer"},"max_domains":{"type":"integer"}}}]},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"type":"object","properties":{"domain":{"type":"string","example":"mail.acme.com"},"dns_records":{"type":"array","items":{"$ref":"#/components/schemas/DNSRecord"}}}},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"type":"object","properties":{"verified":{"type":"boolean"},"status":{"type":"string","enum":["verified","failed"]},"results":{"type":"object","properties":{"domain_verification":{"type":"boolean"},"spf":{"type":"boolean"},"dkim":{"type":"boolean"},"dmarc":{"type":"boolean"},"bounce_cname":{"type":"object","properties":{"valid":{"type":"boolean"},"optional":{"type":"boolean"},"message":{"type":"string"}}}}},"message":{"type":"string"}}},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master toggle for all tracking (null = use customer default)"},"children":[]}]}]}],"example":true},"open_tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track email opens (null = use customer default)"},"children":[]}]}]}],"example":false},"click_tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Track link clicks (null = use customer default)"},"children":[]}]}]}],"example":true},"unsubscribe_header_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include List-Unsubscribe header (null = use customer default)"},"children":[]}]}]}],"example":true}}},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"tracking_enabled":{"type":"boolean","nullable":true},"open_tracking_enabled":{"type":"boolean","nullable":true},"click_tracking_enabled":{"type":"boolean","nullable":true},"unsubscribe_header_enabled":{"type":"boolean","nullable":true},"updated_at":{"type":"string","format":"date-time"}}},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Domain deleted successfully"}}},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master tracking toggle override (null = inherit from account)"},"children":[]}]}]}]},"open_tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open tracking pixel override (null = inherit from account)"},"children":[]}]}]}]},"click_tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click tracking / link rewriting override (null = inherit from account)"},"children":[]}]}]}]},"unsubscribe_header_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List-Unsubscribe header override (null = inherit from account)"},"children":[]}]}]}]},"account_defaults":{"type":"object","description":"Resolved account-level values, shown when domain setting is null","properties":{"tracking_enabled":{"type":"boolean"},"open_tracking_enabled":{"type":"boolean"},"click_tracking_enabled":{"type":"boolean"},"unsubscribe_header_enabled":{"type":"boolean"}}},"is_in_sandbox":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True when the account is in its initial review period (< 14 days old,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tag). Click tracking cannot be fully disabled during this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period. UI should lock the click tracking toggle."},"children":[]}]}]}]},"sandbox_message":{"type":"string","nullable":true,"description":"Human-readable explanation for why click tracking is locked. Null when not in sandbox."}}},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Master toggle (null = inherit from account)"},"children":[]}]}]}]},"open_tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open tracking pixel (null = inherit from account)"},"children":[]}]}]}]},"click_tracking_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click tracking / link rewriting (null = inherit from account). Ignored during sandbox."},"children":[]}]}]}]},"unsubscribe_header_enabled":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List-Unsubscribe header (null = inherit from account)"},"children":[]}]}]}]}}},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Tracking settings updated successfully"}}},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"type":"object","properties":{"domain_id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"age_in_days":{"type":"integer","description":"Domain age in days"},"verification_status":{"type":"string","enum":["pending","verified","failed"]},"health_score":{"type":"integer","nullable":true,"description":"Domain health score (0-100)"},"health_grade":{"type":"string","nullable":true,"description":"Letter grade (A-F)"},"stats":{"type":"object","properties":{"total_sent":{"type":"integer"},"delivered":{"type":"integer"},"bounced":{"type":"integer"},"spam":{"type":"integer"},"spam_rate":{"type":"number","description":"Spam rate percentage"}}},"has_custom_tracking_domain":{"type":"boolean"},"test_mode_recommended":{"type":"string","enum":["basic","standard","full"]},"ready_to_send":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"severity":{"type":"string","enum":["critical","high","medium","info"]},"message":{"type":"string"},"recommendation":{"type":"string"},"action":{"type":"string"}}}},"checklist":{"type":"object","properties":{"dns_verified":{"type":"boolean"},"domain_age_ok":{"type":"boolean"},"has_sends":{"type":"boolean"},"low_spam_rate":{"type":"boolean"},"has_custom_tracking":{"type":"boolean"},"healthy_score":{"type":"boolean","nullable":true}}},"recommendations":{"type":"object","properties":{"basic":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"recommended_for":{"type":"string"},"features":{"type":"object"}}},"standard":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"recommended_for":{"type":"string"}}},"full":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"recommended_for":{"type":"string"}}}}}}},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"type":"object","required":["tracking_domain_id"],"properties":{"tracking_domain_id":{"type":"string","format":"uuid","nullable":true,"description":"Tracking domain ID to assign (null to clear assignment and use smart matching)"}}},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"assignment":{"type":"object","properties":{"domain_id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"tracking_domain_id":{"type":"string","format":"uuid","nullable":true},"tracking_domain":{"type":"string","nullable":true}}}}},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"type":"object","properties":{"domain_id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"assignment":{"type":"object","properties":{"tracking_domain_id":{"type":"string","format":"uuid","nullable":true},"tracking_domain":{"type":"string","nullable":true},"is_verified":{"type":"boolean","nullable":true},"assignment_type":{"type":"string","enum":["explicit","smart_matching"]}}}}},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","description":"The tracking domain (subdomain recommended)","example":"track.yourdomain.com"}}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Tracking domain ID"},"domain":{"type":"string","description":"The tracking domain"},"cname_target":{"type":"string","description":"CNAME target for DNS configuration"},"is_verified":{"type":"boolean","description":"Verification status"},"ssl_enabled":{"type":"boolean","description":"SSL certificate status"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"dns_setup":{"type":"object","properties":{"record_type":{"type":"string","example":"CNAME"},"hostname":{"type":"string","description":"The hostname to configure"},"value":{"type":"string","description":"The value to point to"},"instructions":{"type":"string","description":"Setup instructions"}}}}},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Reserved domain"},"message":{"type":"string","example":"This hostname is reserved by the platform and cannot be used as a tracking domain."}}},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Domain already exists"},"message":{"type":"string","example":"This tracking domain is already registered to your account"}}},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"type":"object","properties":{"tracking_domains":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"cname_target":{"type":"string"},"is_verified":{"type":"boolean"},"verified_at":{"type":"string","format":"date-time","nullable":true},"ssl_enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"https_url":{"type":"string","nullable":true,"description":"HTTPS URL (only if SSL enabled)"}}}}}},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"cname_target":{"type":"string"},"is_verified":{"type":"boolean"},"verified_at":{"type":"string","format":"date-time","nullable":true},"ssl_enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"https_url":{"type":"string","nullable":true},"dns_setup":{"type":"object","properties":{"record_type":{"type":"string"},"hostname":{"type":"string"},"value":{"type":"string"},"instructions":{"type":"string"}}}}},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","description":"The new tracking domain","example":"link.yourdomain.com"}}},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"domain":{"type":"string"},"cname_target":{"type":"string"},"is_verified":{"type":"boolean"},"ssl_enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"message":{"type":"string"},"dns_setup":{"type":"object"}}},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Tracking domain deleted successfully"},"domain":{"type":"string","example":"track.yourdomain.com"}}},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Domain in use"},"message":{"type":"string","example":"Cannot delete tracking domain. It is currently used by 2 sending domain(s)"},"domains_using":{"type":"array","items":{"type":"string"},"example":["mail.yourdomain.com","newsletter.yourdomain.com"]}}},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"object","properties":{"verified":{"type":"boolean"},"domain":{"type":"string"},"cname_target":{"type":"string"},"dns_records":{"type":"array","items":{"type":"string"},"description":"Actual DNS records found"},"message":{"type":"string"},"ssl":{"type":"object","properties":{"status":{"type":"string","enum":["not_available","provisioning"]},"message":{"type":"string"},"enabled":{"type":"boolean"}}},"next_steps":{"type":"array","items":{"type":"string"}}}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["unavailable","provisioning","pending","active"]},"enabled":{"type":"boolean"},"https_url":{"type":"string","nullable":true},"message":{"type":"string"},"domain":{"type":"string"},"certificate":{"type":"object","nullable":true,"properties":{"issuer":{"type":"string"},"auto_renewal":{"type":"boolean"}}},"next_steps":{"type":"array","items":{"type":"string"}}}},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"provisioning"},"message":{"type":"string"},"domain":{"type":"string"},"https_url":{"type":"string"},"next_steps":{"type":"array","items":{"type":"string"}},"troubleshooting":{"type":"object","properties":{"verify_dns":{"type":"string"},"check_propagation":{"type":"string"},"test_http":{"type":"string"}}}}},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Domain not verified"},"message":{"type":"string","example":"Domain must be verified before enabling SSL. Call POST /api/v1/customer/tracking-domains/:id/verify first."}}},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"type":"string","enum":["day","hour"],"default":"day"},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"sent_count":{"type":"integer"}}}}}},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"delivered_count":{"type":"integer"}}}},"domain_id":{"type":"integer","nullable":true}}},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"bounce_count":{"type":"integer"},"hard_bounce":{"type":"integer"},"soft_bounce":{"type":"integer"}}}}}},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"spam_complaints":{"type":"integer"}}}}}},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"open_count":{"type":"integer"},"unique_opens":{"type":"integer"}}}}}},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"object","properties":{"platforms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Gmail"},"count":{"type":"integer"}}}}}},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"type":"object","properties":{"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"click_count":{"type":"integer"},"unique_clicks":{"type":"integer"}}}}}},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"type":"object","properties":{"subject":{"type":"string","description":"Email subject line","maxLength":1000},"html":{"type":"string","description":"HTML email content"},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plain text email body. If omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, a plain-text version is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically generated from the HTML before sending."},"children":[]}]}]}]}},"required":["subject"],"example":{"subject":"Your Monthly Newsletter","html":"<html><body><h1>Hello!</h1><p>Check out our latest updates...</p></body></html>","text":"Hello! Check out our latest updates..."}},"id":"schema_320"},"schema_321":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"error"},"error":{"type":"string","example":"invalid_request"},"message":{"type":"string","example":"Subject, HTML, or text is required."}}},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"error"},"error":{"type":"string","example":"unauthorized"},"message":{"type":"string","example":"Authentication required. Use \"X-API-Key: <customer_api_key>\" header."}}},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"error"},"error":{"type":"string","example":"account_suspended"},"message":{"type":"string"}}},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"error"},"error":{"type":"string","example":"spam_check_quota_exceeded"},"message":{"type":"string","example":"You have reached your monthly spam check limit."},"usage":{"type":"object","properties":{"used":{"type":"integer"},"limit":{"type":"integer"},"period":{"type":"string"}}}}},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"error"},"error":{"type":"string","example":"internal_error"},"message":{"type":"string"}}},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email address to validate","example":"user@example.com"}},"required":["email"]},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"object"}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"},"usage":{"type":"object"}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"object","properties":{"emails":{"type":"array","description":"Array of email addresses to validate (duplicates are removed)","minItems":1,"maxItems":1000,"items":{"type":"string","format":"email"},"example":["user1@example.com","user2@gmail.com"]},"async":{"type":"boolean","default":false,"description":"Force asynchronous processing. Batches over 100 unique emails\nare always processed asynchronously regardless of this flag.\n"}},"required":["emails"]},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"type":"object","properties":{"total":{"type":"integer","description":"Total emails validated"},"valid_count":{"type":"integer","description":"Number of valid emails"},"invalid_count":{"type":"integer","description":"Number of invalid emails"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EmailValidationResult"}},"usage":{"type":"object","properties":{"used":{"type":"integer"},"limit":{"type":"integer"},"remaining":{"type":"integer"}}}}},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid","description":"Validation job identifier"},"status":{"type":"string","enum":["queued"]},"total":{"type":"integer","description":"Number of unique emails accepted for validation"},"status_url":{"type":"string","description":"Path to poll for job progress"},"results_url":{"type":"string","description":"Path to fetch per-email results"}}},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","running","completed","failed","partial_failed"]},"total":{"type":"integer"},"processed":{"type":"integer"},"progress_percent":{"type":"integer"},"valid":{"type":"integer"},"invalid":{"type":"integer"},"risky":{"type":"integer"},"failed":{"type":"integer"},"chunk_count":{"type":"integer"},"chunks_completed":{"type":"integer"},"chunks_failed":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"started_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true}}},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"string","enum":["valid","invalid","risky","failed"]},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"object","properties":{"job":{"type":"object","description":"Job status summary (same shape as the job status endpoint)"},"results":{"type":"array","items":{"type":"object","description":"Per-email validation result with summary status","properties":{"email":{"type":"string"},"status":{"type":"string","enum":["valid","invalid","risky","failed"]},"reason":{"type":"string"},"is_valid":{"type":"boolean"},"validation_checks":{"type":"object"},"risk_level":{"type":"string","enum":["low","medium","high"]},"deliverability_score":{"type":"integer"},"validated_at":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"total_pages":{"type":"integer"}}}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"object","properties":{"validation_limit":{"type":"integer","description":"Monthly validation limit"},"validations_used":{"type":"integer","description":"Validations used this month"},"validations_remaining":{"type":"integer","description":"Validations remaining this month"},"period":{"type":"string","description":"Quota period","example":"monthly"},"reset_date":{"type":"string","format":"date","description":"Date when quota resets"}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"object","required":["to","subject"],"properties":{"to":{"type":"string","format":"email","description":"Recipient email address","example":"user@example.com"},"subject":{"type":"string","description":"Email subject line","example":"Welcome to our platform"},"html":{"type":"string","description":"HTML content (optional)","example":"<p>Welcome to our platform!</p>"},"text":{"type":"string","description":"Plain text content (optional)","example":"Welcome to our platform!"},"is_bulk":{"type":"boolean","description":"Whether this is bulk/marketing email","default":false}}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"object","required":["risk_score","risk_level","would_block","action"],"properties":{"risk_score":{"type":"integer","description":"Overall risk score (0-100)","minimum":0,"maximum":100,"example":15},"risk_level":{"type":"string","enum":["safe","low","medium","high"],"description":"Risk level category","example":"safe"},"would_block":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Critical field:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Indicates if /api/v1/send will block this email."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, calling /send will result in the same block with the same reason_code."},"children":[]}]}]}],"example":false},"action":{"type":"string","enum":["allow","warn","soft_block","block"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform decision on this send:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Will send without warnings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Will send but risk warning shown in logs/dashboard"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soft_block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Platform will block /send unless customer takes explicit corrective action (verify domain, remove recipient, fix content). Not the same as \"warn\" - this requires action."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"block"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Hard block - cannot send under any circumstances"},"children":[]}]}]}]}],"example":"allow"},"reason_code":{"type":"string","description":"Stable machine-readable reason code (null if allowed).\nUse this for programmatic decision-making.\n","nullable":true,"enum":[null,"disposable_high_confidence","disposable_medium_confidence","sender_not_verified","spamtrap_detected","previous_complaint","previous_hard_bounce","content_risk_high","velocity_first_send_bulk","volume_spike","risk_score_critical"],"example":null},"block_reason":{"type":"string","description":"Human-readable explanation (null if allowed)","nullable":true,"example":null},"risk_factors":{"type":"array","description":"Detailed breakdown of risk factors that contributed to score","items":{"type":"object","properties":{"type":{"type":"string","description":"Stable factor type code","example":"free_email_provider"},"points":{"type":"integer","description":"Points contributed by this factor","example":5},"message":{"type":"string","description":"Human-readable explanation","example":"Sending to free email provider"}}}},"breakdown":{"type":"object","description":"Risk score breakdown by category","properties":{"recipient":{"type":"integer","description":"Recipient risk score (0-40)","example":5},"content":{"type":"integer","description":"Content risk score (0-30)","example":5},"sender":{"type":"integer","description":"Sender risk score (0-20)","example":0},"behavior":{"type":"integer","description":"Behavior/velocity risk score (0-10)","example":0}}},"recommendations":{"type":"array","description":"Actionable recommendations to reduce risk","items":{"type":"string"},"example":["Consider verifying sender domain with DKIM/SPF","Review content for spam triggers"]},"policy_snapshot":{"type":"object","description":"Enforcement policy settings at time of preview.\nUse this to correlate why an old preview doesn't match a later /send if settings changed.\n","properties":{"block_disposable_emails":{"type":"boolean","description":"Whether disposable emails are blocked","example":true},"enforce_sender_verification":{"type":"boolean","description":"Whether sender verification is required","example":true},"disposable_confidence_threshold":{"type":"number","format":"float","description":"Confidence threshold for disposable blocking (0.0-1.0)","example":0.85},"customer_plan":{"type":"string","description":"Customer plan tier (affects soft blocks and throttling)","example":"professional"}}},"engine_version":{"type":"string","description":"Risk scoring engine version for tracking/debugging","example":"risk-v3.2"},"quota":{"type":"object","description":"Current Risk API quota status","properties":{"used":{"type":"integer","example":43},"limit":{"type":"integer","example":1000},"remaining":{"type":"integer","example":957},"reset_at":{"type":"string","format":"date-time","description":"When quota resets (typically start of next month)","example":"2025-02-01T00:00:00Z"}}}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"validation_error"},"message":{"type":"string","example":"Invalid email address"}}},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"feature_not_available"},"message":{"type":"string","example":"Risk Score API is not available for your account. Please upgrade to a Professional or Enterprise plan."},"upgrade_info":{"type":"object","properties":{"feature":{"type":"string","example":"Risk Score API"},"available_on":{"type":"array","items":{"type":"string"},"example":["Professional","Enterprise"]},"benefits":{"type":"array","items":{"type":"string"},"example":["Preview risk scores before sending","Reduce bounce rates proactively","Comply with sending policies","Improve delivery reputation"]}}}}},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"quota_exceeded"},"message":{"type":"string","example":"Monthly risk API quota exceeded (1000/1000). Resets on 2025-02-01."},"quota":{"type":"object","properties":{"used":{"type":"integer","example":1000},"limit":{"type":"integer","example":1000},"resets_at":{"type":"string","format":"date-time","example":"2025-02-01T00:00:00Z"}}}}},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"type":"object","required":["enabled","quota"],"properties":{"enabled":{"type":"boolean","description":"Whether risk API is enabled for this customer","example":true},"quota":{"type":"object","required":["limit","used","remaining","reset_at"],"properties":{"limit":{"type":"integer","description":"Monthly API call limit","example":1000},"used":{"type":"integer","description":"API calls used this month","example":247},"remaining":{"type":"integer","description":"API calls remaining this month","example":753},"reset_at":{"type":"string","format":"date-time","description":"When quota resets (typically start of next month)","example":"2025-02-01T00:00:00Z"}}},"analytics":{"type":"object","description":"Risk analytics across all previews this month","properties":{"total_previews":{"type":"integer","description":"Total risk previews this month","example":247},"average_risk_score":{"type":"number","format":"float","description":"Average risk score across all previews","example":28.5},"would_block_count":{"type":"integer","description":"Number of previews that would be blocked","example":12},"would_block_percentage":{"type":"number","format":"float","description":"Percentage of previews that would be blocked","example":4.9},"breakdown":{"type":"object","description":"Average score breakdown by category","properties":{"recipient":{"type":"number","format":"float","description":"Average recipient risk (0-40)","example":12.3},"content":{"type":"number","format":"float","description":"Average content risk (0-30)","example":8.7},"sender":{"type":"number","format":"float","description":"Average sender risk (0-20)","example":5.2},"behavior":{"type":"number","format":"float","description":"Average behavior risk (0-10)","example":2.3}}}}},"top_factors":{"type":"array","description":"Most common risk factors detected (top 5)","items":{"type":"object","properties":{"reason_code":{"type":"string","description":"Stable factor code","example":"disposable_medium_confidence"},"count":{"type":"integer","description":"Number of times detected","example":45},"percentage":{"type":"number","format":"float","description":"Percentage of total previews","example":18.2}}},"example":[{"reason_code":"disposable_medium_confidence","count":45,"percentage":18.2},{"reason_code":"sender_not_verified","count":38,"percentage":15.4},{"reason_code":"content_risk_medium","count":23,"percentage":9.3}]}}},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"type":"string","enum":["queued","sent","delivered","bounced","failed","deferred","complained","opened","clicked","unsubscribed"]},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"type":"string","format":"email"},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"type":"integer","default":1,"minimum":1},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"integer","default":50,"minimum":1,"maximum":100},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/EmailEvent"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","enum":["event_tracking_disabled","event_api_disabled"]},"message":{"type":"string"}}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"object","properties":{"email_id":{"type":"string","format":"uuid"},"events":{"type":"array","items":{"$ref":"#/components/schemas/EmailEvent"}},"summary":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NEW - Event Statistics:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Aggregate counts for quick insights."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick overview of event breakdown including human engagement."},"children":[]}]}]}],"properties":{"total_events":{"type":"integer","description":"Total number of events"},"human_engagement_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of real human engagements (opens/clicks with scanner_confidence < 50)"},"children":[]}]}]}]},"scanner_detected_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of scanner/bot events detected (scanner_confidence >= 80)"},"children":[]}]}]}]}},"example":{"total_events":5,"human_engagement_count":2,"scanner_detected_count":0}},"timeline":{"type":"array","items":{"type":"object","properties":{"event_type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"status":{"type":"string"},"details":{"type":"object"}}}}}},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Email not found or access denied"}}},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"string","enum":["hard","soft","complaint","block","unknown"]},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"integer","default":100,"minimum":1,"maximum":1000},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"integer","default":0,"minimum":0},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"recipient":{"type":"string","format":"email"},"bounce_type":{"type":"string","enum":["hard","soft","complaint","block","unknown"],"description":"Type of bounce detected"},"smtp_code":{"type":"string","description":"SMTP status code (e.g., \"550 5.1.1\")","example":"550 5.1.1","nullable":true},"reason":{"type":"string","description":"Human-readable bounce reason (cleaned/truncated)","example":"550 5.1.1"},"diagnostic_code":{"type":"string","description":"Full diagnostic error message from mail server","example":"Recipient rejected (hard bounce): 550 5.1.1 https://support.google.com/mail/?p=NoSuchUser af79cd13be357-8cbbf6f97dbsi325859585a.212 - gsmtp"},"domain_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the sending domain"},"domain_name":{"type":"string","nullable":true,"description":"Name of the sending domain","example":"braincert.com"},"source":{"type":"string","description":"Source of the bounce record","example":"smtp"},"created_at":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"has_more":{"type":"boolean"}}}}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"string","enum":["bounce","complaint","unsubscribe"]},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"object","properties":{"suppressions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"type":{"type":"string","enum":["bounce","complaint","unsubscribe"]},"reason":{"type":"string"},"source":{"type":"string"},"domain_id":{"type":"string","format":"uuid","nullable":true,"description":"ID of the sending domain (if domain-specific)"},"domain_name":{"type":"string","nullable":true,"description":"Name of the sending domain (if domain-specific)","example":"braincert.com"},"created_at":{"type":"string","format":"date-time"}}}},"counts":{"type":"object","properties":{"bounce":{"type":"integer"},"complaint":{"type":"integer"},"unsubscribe":{"type":"integer"}}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"Email address to suppress"},"type":{"type":"string","enum":["bounce","complaint","unsubscribe"],"default":"unsubscribe","description":"Type of suppression"},"domain_id":{"type":"string","format":"uuid","description":"Optional - Domain ID for domain-specific suppression"},"reason":{"type":"string","description":"Optional reason or description"}},"example":{"email":"user@example.com","type":"unsubscribe","reason":"User requested removal"}},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"suppression":{"type":"object"}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"email":{"type":"string"},"type":{"type":"string"},"scope":{"type":"string"}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"type":"object","properties":{"unsubscribes":{"type":"array","items":{"$ref":"#/components/schemas/Unsubscribe"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"Email address to unsubscribe"},"domain_id":{"type":"string","format":"uuid","description":"Optional - Specify domain ID for domain-specific unsubscribe. Omit for global unsubscribe."},"reason":{"type":"string","description":"Optional reason for unsubscribe"}},"example":{"email":"user@example.com","domain_id":"123e4567-e89b-12d3-a456-426614174000","reason":"User requested removal"}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Email unsubscribed successfully"},"unsubscribe":{"$ref":"#/components/schemas/Unsubscribe"}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Invalid email address"},"message":{"type":"string"}}},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Already unsubscribed"},"message":{"type":"string"}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"object","required":["emails"],"properties":{"emails":{"type":"array","minItems":1,"maxItems":10000,"items":{"type":"string","format":"email"},"description":"Email addresses to unsubscribe"},"domain_id":{"type":"string","format":"uuid","description":"Optional - Specify domain ID for domain-specific unsubscribes. Omit for global unsubscribes."},"reason":{"type":"string","description":"Optional reason for unsubscribe"}},"example":{"emails":["user@example.com","another@example.com"],"reason":"CSV import"}},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Unsubscribe import completed"},"imported":{"type":"integer","example":245},"skipped":{"type":"integer","example":12},"failed":{"type":"integer","example":2},"invalid_emails":{"type":"array","items":{"type":"string"}},"duplicate_count":{"type":"integer"},"already_unsubscribed":{"type":"integer"},"scope":{"type":"string","enum":["global","domain-specific"]}}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Email re-subscribed successfully"},"email":{"type":"string","format":"email"}}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Not found"},"message":{"type":"string"}}},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"object","properties":{"scope":{"type":"string","enum":["global","domain"],"description":"Indicates if this is a global (all domains) or domain-specific score"},"domain":{"type":"object","description":"Domain details (only present when scope is 'domain')","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}}},"health_score":{"$ref":"#/components/schemas/HealthScore"},"insights":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["success","info","warning","error"]},"message":{"type":"string"}}}},"benchmarks":{"type":"object","properties":{"delivery_rate":{"type":"object","properties":{"good":{"type":"number"},"average":{"type":"number"},"poor":{"type":"number"}}},"open_rate":{"type":"object","properties":{"good":{"type":"number"},"average":{"type":"number"},"poor":{"type":"number"}}},"bounce_rate":{"type":"object","properties":{"good":{"type":"number"},"average":{"type":"number"},"poor":{"type":"number"}}},"complaint_rate":{"type":"object","properties":{"good":{"type":"number"},"average":{"type":"number"},"poor":{"type":"number"}}}}}}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string","example":"No data available yet. Send some emails first."}}},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"integer","default":30,"minimum":1,"maximum":365},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"type":"object","properties":{"history":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"overall_score":{"type":"number"},"delivery_rate":{"type":"number"},"open_rate":{"type":"number"},"click_rate":{"type":"number"},"bounce_rate":{"type":"number"},"complaint_rate":{"type":"number"}}}},"period_days":{"type":"integer"}}},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"object","properties":{"health_score":{"$ref":"#/components/schemas/HealthScore"},"insights":{"type":"object","properties":{"status":{"type":"string"},"summary":{"type":"string"}}},"message":{"type":"string","example":"Health score refreshed successfully"}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string","example":"Send some emails first to generate a health score"}}},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":"Original URL from the email"}}},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"string","example":"Unsubscribed successfully"},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"type":"string","example":"Invalid token"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEndpoint"}},"limit":{"type":"integer","description":"Maximum webhook endpoints allowed","example":10},"used":{"type":"integer","description":"Number of webhooks currently configured","example":3}}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"object","required":["url","events"],"properties":{"name":{"type":"string","description":"Optional webhook identifier","example":"Production Webhook"},"url":{"type":"string","format":"uri","description":"HTTPS URL for webhook delivery","example":"https://api.example.com/webhooks/email-events"},"description":{"type":"string","description":"Optional notes about this webhook","example":"Main production webhook for email events"},"domain_ids":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional array of domain UUIDs to scope webhook to specific domains."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or empty array: webhook receives events from ALL domains (customer-level)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If array with 1 UUID: webhook receives events from ONE domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If array with multiple UUIDs: webhook receives events from those specific domains (domain group)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Case:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If your plan has 20 domains but only 5 webhook endpoints, group related domains together."},"children":[]}]}]}],"example":["550e8400-e29b-41d4-a716-446655440001","550e8400-e29b-41d4-a716-446655440002"]},"domain_id":{"type":"string","format":"uuid","nullable":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED: Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array instead. For backward compatibility, this is converted to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain_ids: [domain_id]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"550e8400-e29b-41d4-a716-446655440000"},"events":{"type":"array","description":"Event types to receive","items":{"type":"string","enum":["email.sent","email.delivered","email.opened","email.clicked","email.bounced","email.complained","email.unsubscribed","email.failed","contact.created","contact.updated","contact.unsubscribed","contact.deleted","contact.tag_added","contact.tag_removed","contact.confirmed"]},"example":["email.delivered","email.opened","email.clicked","email.bounced"]},"is_active":{"type":"boolean","description":"Enable/disable webhook","default":true}}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookEndpointWithSecret"},"webhook":{"$ref":"#/components/schemas/WebhookEndpointWithSecret"},"message":{"type":"string","example":"Webhook created successfully"}}},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Webhook limit reached (3/3 used). Upgrade your plan or delete an existing webhook."}}},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"domain_ids":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional array of domain UUIDs to change webhook scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to null or []: webhook receives events from ALL domains (customer-level)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to [uuid]: webhook receives events from ONE domain"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to [uuid1, uuid2, ...]: webhook receives events from those domains (domain group)"},"children":[]}]}]}]}]},"domain_id":{"type":"string","format":"uuid","nullable":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED - Use domain_ids instead"},"children":[]}]}]}]},"events":{"type":"array","items":{"type":"string","enum":["email.sent","email.delivered","email.opened","email.clicked","email.bounced","email.complained","email.unsubscribed","email.failed","contact.created","contact.updated","contact.unsubscribed","contact.deleted","contact.tag_added","contact.tag_removed","contact.confirmed"]}},"is_active":{"type":"boolean"}}},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"object","properties":{"webhook":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"domain_ids":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"events":{"type":"array","items":{"type":"string","enum":["email.sent","email.delivered","email.opened","email.clicked","email.bounced","email.complained","email.unsubscribed","email.failed","contact.created","contact.updated","contact.unsubscribed","contact.deleted","contact.tag_added","contact.tag_removed","contact.confirmed"]}},"is_active":{"type":"boolean"}}},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookEndpoint"},"webhook":{"$ref":"#/components/schemas/WebhookEndpoint"}}},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Webhook deleted successfully"}}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","example":"Test webhook sent successfully"},"status":{"type":"integer","description":"HTTP status code from webhook endpoint","example":200},"response_time":{"type":"integer","description":"Response time in milliseconds","example":145}}},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookEndpointWithSecret"},"webhook":{"$ref":"#/components/schemas/WebhookEndpointWithSecret"},"message":{"type":"string","example":"Webhook secret regenerated successfully"}}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"type":"string","enum":["all","subscribed","pending_confirmation","unsubscribed","bounced","complained"],"default":"subscribed"},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"type":"string","enum":["created_at","updated_at","email","name","last_sent_at","total_sent","total_opened","total_clicked"],"default":"created_at"},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"default":"desc"},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique contact identifier"},"email":{"type":"string","format":"email","description":"Contact email address"},"name":{"type":"string","description":"Full name"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"phone":{"type":"string","description":"Phone number"},"city":{"type":"string","description":"City"},"country":{"type":"string","description":"Country"},"status":{"type":"string","enum":["subscribed","pending_confirmation","unsubscribed","bounced","complained"],"description":"Contact subscription status"},"total_sent":{"type":"integer","description":"Total emails sent to this contact","example":8},"total_opened":{"type":"integer","description":"Total times this contact opened emails","example":3},"total_clicked":{"type":"integer","description":"Total times this contact clicked links","example":2},"last_sent_at":{"type":"string","format":"date-time","description":"Last time an email was sent to this contact"},"bounce_count":{"type":"integer","description":"Number of bounces from this contact"},"complaint_count":{"type":"integer","description":"Number of spam complaints from this contact"},"engagement_score":{"type":"integer","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intelligent engagement score (0-100) calculated from:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send activity (base 20 points)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open rate (up to 40 points)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click rate (up to 30 points, weighted higher)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recency of engagement (up to 10 points)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Penalties for bounces and complaints"},"children":[]}]}]}]}],"example":78},"engagement_label":{"type":"string","enum":["Highly Engaged","Engaged","Moderate","Cold","Inactive","No Activity"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable engagement label:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Highly Engaged\" (70-100)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Engaged\" (50-69)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Moderate\" (30-49)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Cold\" (10-29)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Inactive\" (0-9)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"No Activity\" (0 sends)"},"children":[]}]}]}]}],"example":"Highly Engaged"},"engagement_color":{"type":"string","enum":["green","blue","yellow","orange","red","gray"],"description":"Suggested color for UI display","example":"green"},"engagement_breakdown":{"type":"object","description":"Detailed engagement metrics for tooltip/expanded view","properties":{"open_rate":{"type":"integer","description":"Open rate as percentage","example":38},"click_rate":{"type":"integer","description":"Click rate as percentage","example":25},"total_sent":{"type":"integer","example":8},"total_opened":{"type":"integer","example":3},"total_clicked":{"type":"integer","example":2},"days_since_last_send":{"type":"integer","nullable":true,"description":"Days since last email was sent","example":6}}},"custom_fields":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy custom fields (prefer custom_properties)"},"children":[]}]}]}],"additionalProperties":true},"custom_properties":{"type":"object","description":"User-defined custom properties","additionalProperties":true},"tags":{"type":"array","items":{"type":"string"},"description":"Tags assigned to this contact"},"source":{"type":"string","enum":["api","import","form","manual","auto"],"description":"Origin of this contact"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer","example":1},"limit":{"type":"integer","example":100},"total":{"type":"integer","description":"Total number of contacts","example":239},"total_pages":{"type":"integer","description":"Total pages available","example":3}}}}},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"Contact email address (unique per customer)","example":"john@example.com"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name (optional if first_name and last_name provided)"},"children":[]}]}]}],"example":"John Doe"},"first_name":{"type":"string","description":"First name","example":"John"},"last_name":{"type":"string","description":"Last name","example":"Doe"},"phone":{"type":"string","description":"Phone number","example":"+1234567890"},"city":{"type":"string","description":"City","example":"San Francisco"},"country":{"type":"string","description":"Country","example":"USA"},"status":{"type":"string","enum":["subscribed","pending_confirmation","unsubscribed","bounced","complained"],"default":"subscribed","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact subscription status. Prefer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"double_opt_in: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly."},"children":[]}]}]}]},"double_opt_in":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, creates the contact as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_confirmation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sends a confirmation email, and changes status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscribed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only after the subscriber confirms."},"children":[]}]}]}]},"consent":{"type":"object","description":"Optional consent/audit metadata stored with the confirmation request.","properties":{"ip":{"type":"string","example":"203.0.113.8"},"user_agent":{"type":"string","example":"Mozilla/5.0"},"source_url":{"type":"string","format":"uri","example":"https://example.com/newsletter"},"timestamp":{"type":"string","format":"date-time","example":"2026-07-06T14:20:15Z"},"consent_text":{"type":"string","example":"I agree to receive newsletters."}}},"confirmation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional confirmation email settings. Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"double_opt_in: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"from_email":{"type":"string","format":"email","description":"Optional sender address. Its domain must be a verified sending domain on your account.","example":"newsletter@example.com"},"from_name":{"type":"string","description":"Optional sender display name. Defaults to the account/company name.","example":"Example Brand"},"template_id":{"type":"string","description":"Optional customer-owned confirmation template ID.","example":"tpl_123"},"redirect_url":{"type":"string","format":"uri","description":"Optional URL to redirect the subscriber to after successful confirmation.","example":"https://example.com/confirmed"}}},"custom_fields":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy custom fields (prefer custom_properties)"},"children":[]}]}]}],"additionalProperties":true,"example":{"legacy_field":"value"}},"custom_properties":{"type":"object","description":"User-defined custom properties (flexible JSONB storage)","additionalProperties":true,"example":{"company":"Acme Inc","role":"Manager","plan":"premium"}},"tags":{"type":"array","items":{"type":"string"},"description":"Array of tags to assign","example":["premium","early-adopter"]},"source":{"type":"string","enum":["api","import","form","manual"],"default":"api","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source/origin of this contact:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Created via API (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bulk CSV import"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Web form submission"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Manually created via dashboard"},"children":[]}]}]}]}],"example":"api"}}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"email":{"type":"string","example":"jane@example.com"},"created_at":{"type":"string","format":"date-time"},"double_opt_in":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when the contact was created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"double_opt_in: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"status":{"type":"string","example":"pending_confirmation"},"confirmation_email_id":{"type":"string","format":"uuid"},"from_email":{"type":"string","format":"email"},"expires_at":{"type":"string","format":"date-time"}}}}}}},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Contact with this email already exists"}}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"type":"object","properties":{"confirmation":{"type":"object","properties":{"from_email":{"type":"string","format":"email","description":"Optional sender address. Domain must be verified for this account."},"from_name":{"type":"string"},"template_id":{"type":"string"},"redirect_url":{"type":"string","format":"uri"}}}}},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"Confirmation email queued"},"contact_id":{"type":"string","format":"uuid"},"confirmation_email_id":{"type":"string","format":"uuid"},"expires_at":{"type":"string","format":"date-time"}}},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"type":"object","required":["contacts"],"properties":{"contacts":{"type":"array","minItems":1,"maxItems":10000,"description":"Array of contact objects to import","items":{"type":"object","required":["email","first_name","last_name"],"properties":{"email":{"type":"string","format":"email","description":"Contact email address (unique per customer)","example":"jane@example.com"},"first_name":{"type":"string","description":"First name (required for import)","example":"Jane"},"last_name":{"type":"string","description":"Last name (required for import)","example":"Doe"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name (optional, auto-generated from first_name + last_name if not provided)"},"children":[]}]}]}],"example":"Jane Doe"},"phone":{"type":"string","description":"Phone number","example":"+1234567890"},"city":{"type":"string","description":"City","example":"San Francisco"},"country":{"type":"string","description":"Country","example":"USA"},"status":{"type":"string","enum":["subscribed","pending_confirmation","unsubscribed","bounced","complained"],"default":"subscribed","description":"Contact status"},"tags":{"type":"array","items":{"type":"string"},"description":"Array of tags to assign to this contact","example":["newsletter","vip"]},"custom_fields":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy custom fields (will be merged with custom_properties)"},"children":[]}]}]}],"additionalProperties":true,"example":{"legacy_field":"value"}},"custom_properties":{"type":"object","description":"User-defined custom properties (flexible JSONB storage)","additionalProperties":true,"example":{"company":"BrainCert","role":"Manager","signup_date":"2026-01-15"}}}}},"on_conflict":{"type":"string","enum":["skip","update"],"default":"skip","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to handle existing contacts with the same email:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Do not modify existing contacts (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Update existing contacts with new data"},"children":[]}]}]}]}]}}},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"created":{"type":"integer","description":"Number of new contacts created","example":98},"updated":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of existing contacts updated (only if on_conflict=update)"},"children":[]}]}]}],"example":0},"skipped":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of existing contacts skipped (only if on_conflict=skip)"},"children":[]}]}]}],"example":2},"errors":{"type":"array","description":"List of contacts that failed to import with error details","items":{"type":"object","properties":{"email":{"type":"string","example":"invalid@"},"error":{"type":"string","example":"Invalid email format"}}}}}}}},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Maximum 10,000 contacts per import"}}},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Contact limit exceeded"},"limit_info":{"type":"object","properties":{"current":{"type":"integer","example":9950},"limit":{"type":"integer","example":10000}}}}},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Failed to import contacts"}}},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object"}}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"status":{"type":"string","enum":["subscribed","pending_confirmation","unsubscribed","bounced","complained"]},"total_sent":{"type":"integer","description":"Total emails sent to this contact"},"total_opened":{"type":"integer","description":"Total times this contact opened emails"},"total_clicked":{"type":"integer","description":"Total times this contact clicked links"},"last_sent_at":{"type":"string","format":"date-time"},"bounce_count":{"type":"integer"},"complaint_count":{"type":"integer"},"engagement_score":{"type":"integer","minimum":0,"maximum":100,"description":"Intelligent engagement score (0-100)"},"engagement_label":{"type":"string","description":"Human-readable engagement level"},"engagement_color":{"type":"string","description":"Suggested color for UI"},"engagement_breakdown":{"type":"object","description":"Detailed engagement metrics","properties":{"open_rate":{"type":"integer"},"click_rate":{"type":"integer"},"total_sent":{"type":"integer"},"total_opened":{"type":"integer"},"total_clicked":{"type":"integer"},"days_since_last_send":{"type":"integer","nullable":true}}},"custom_fields":{"type":"object","additionalProperties":true},"custom_properties":{"type":"object","additionalProperties":true},"tags":{"type":"array","items":{"type":"string"},"description":"Tags assigned to this contact"},"segments":{"type":"array","items":{"type":"string"},"description":"Segments this contact belongs to"},"source":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Update contact's email address (must be unique)","example":"newemail@example.com"},"name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"status":{"type":"string","enum":["subscribed","pending_confirmation","unsubscribed","bounced","complained"]},"custom_fields":{"type":"object"}}},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":"integer","default":50},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":"string","enum":["all","queued","sending","sent","delivered","failed","bounced","complained"],"default":"all"},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"subject":{"type":"string"},"status":{"type":"string"},"from_email":{"type":"string"},"to_email":{"type":"string"},"sent_at":{"type":"string","format":"date-time"},"delivered_at":{"type":"string","format":"date-time"},"opened_at":{"type":"string","format":"date-time"},"clicked_at":{"type":"string","format":"date-time"},"open_count":{"type":"integer"},"click_count":{"type":"integer"},"bounce_type":{"type":"string"},"bounce_reason":{"type":"string"},"events":{"type":"array","description":"Event timeline (included for recent emails)","items":{"type":"object","properties":{"event_type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"ip_address":{"type":"string"},"user_agent":{"type":"string"}}}}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"pages":{"type":"integer"}}}}},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","example":"Highly Engaged Subscribers"},"description":{"type":"string","example":"Contacts who opened >10 emails"},"is_dynamic":{"type":"boolean","example":true},"filter_conditions":{"type":"object","example":{"status":"active","total_opened":{">":10}}},"contact_count":{"type":"integer","example":1247},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"VIP Customers","description":"Unique segment name"},"description":{"type":"string","example":"High-value customers with premium tag"},"is_dynamic":{"type":"boolean","default":true,"description":"If true, segment auto-updates based on filters"},"filter_conditions":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter rules (required for dynamic segments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can use either simple format or filter builder format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Simple: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"status\": \"subscribed\", \"source\": \"form\"}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Builder: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"filters\": [...], \"match_type\": \"all\"}"},"children":[]}]}]}]}],"example":{"filters":[{"field":"status","operator":"equals","value":"subscribed"},{"field":"campaign_opened","operator":"has_opened","value":"campaign-uuid"}],"match_type":"all"}},"contact_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Initial contacts for static segments","example":["uuid1","uuid2"]}}},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","example":"Updated Segment Name"},"description":{"type":"string"},"filter_conditions":{"type":"object","example":{"status":"active","total_opened":{">":15}}}}},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"filter_conditions":{"type":"object"},"match_type":{"type":"string","enum":["all","any"]}}},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"segment_id":{"type":"string","format":"uuid"},"contact_count":{"type":"integer","example":1523,"description":"Number of contacts now in segment"},"refreshed_at":{"type":"string","format":"date-time"}}}}},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"type":"object","required":["filter_conditions"],"properties":{"filter_conditions":{"type":"object","description":"Filter rules to test.\n\nSupports both simple and filter builder formats.\n","example":{"filters":[{"field":"status","operator":"equals","value":"subscribed"},{"field":"campaign_opened","operator":"has_opened","value":"campaign-uuid"}],"match_type":"all"}}}},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"count":{"type":"integer","example":842,"description":"Number of contacts matching filters"}}},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or both (at least one must be non-empty)."},"children":[]}]}]}],"properties":{"contact_ids":{"type":"array","items":{"type":"string","format":"uuid"},"example":["uuid1","uuid2","uuid3"]},"emails":{"type":"array","items":{"type":"string","format":"email"},"example":["alice@example.com","bob@example.com"]}},"anyOf":[{"required":["contact_ids"]},{"required":["emails"]}]},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"added":{"type":"integer"},"skipped":{"type":"integer","description":"Already members of the segment"},"total":{"type":"integer","description":"Total contacts in the segment after the operation"},"unresolved_emails":{"type":"array","description":"Only present when some supplied emails matched no contact","items":{"type":"string"}}}}}},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"type":"object","required":["contact_ids"],"properties":{"contact_ids":{"type":"array","items":{"type":"string","format":"uuid"},"example":["uuid1","uuid2"]}}},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"type":"object","properties":{"tag_name":{"type":"string","example":"premium"},"contact_count":{"type":"integer","example":127},"last_used_at":{"type":"string","format":"date-time"}}}}}},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"type":"object","required":["new_name"],"properties":{"new_name":{"type":"string","description":"New tag name","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z0-9\\s\\-_]+$","example":"newsletter"}}},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"old_name":{"type":"string","example":"newsleter"},"new_name":{"type":"string","example":"newsletter"},"contacts_updated":{"type":"integer","description":"Number of contacts affected","example":127}}}}},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Tag name can only contain letters, numbers, spaces, hyphens, and underscores"}}},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Tag not found"}}},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"Tag \"newsletter\" already exists. Use merge endpoint to combine tags."}}},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"object","required":["source_tags","target_tag"],"properties":{"source_tags":{"type":"array","description":"Array of tag names to merge (must contain at least one tag)","minItems":1,"items":{"type":"string"},"example":["Newsletter","newsletter","NEWSLETTER"]},"target_tag":{"type":"string","description":"Target tag name (will be created if doesn't exist)","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z0-9\\s\\-_]+$","example":"newsletter"}}},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"source_tags":{"type":"array","items":{"type":"string"},"example":["Newsletter","newsletter","NEWSLETTER"]},"target_tag":{"type":"string","example":"newsletter"},"contacts_affected":{"type":"integer","description":"Number of contacts that had at least one source tag","example":150},"tags_removed":{"type":"integer","description":"Total number of tag assignments removed","example":298},"tags_added":{"type":"integer","description":"Number of target tags added (contacts that didn't have it)","example":23}}}}},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"source_tags array is required and must contain at least one tag"}}},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"string","example":"None of the source tags exist"}}},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"type":"object","oneOf":[{"required":["tag"]},{"required":["tags"]}],"properties":{"tag":{"type":"string","example":"premium"},"tags":{"type":"array","items":{"type":"string"},"example":["premium","vip"]}}},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"type":"object","oneOf":[{"required":["tag"]},{"required":["tag_name"]}],"properties":{"tag":{"type":"string","example":"VIP Customer"},"tag_name":{"type":"string","example":"VIP Customer"}}},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Sales Information"},"description":{"type":"string"},"display_order":{"type":"integer"}}},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","example":"Sales Information"},"description":{"type":"string"},"display_order":{"type":"integer"}}},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"display_order":{"type":"integer"}}},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"type":"object","required":["property_key","label","property_type"],"properties":{"property_key":{"type":"string","example":"lead_score"},"label":{"type":"string","example":"Lead Score"},"property_type":{"type":"string","enum":["text","textarea","number","date","datetime","boolean","select","multi_select","url","email","phone","json"]},"options":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for select/multi_select types"},"children":[]}]}]}]}}},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"type":"object","properties":{"group_id":{"type":"string","format":"uuid","nullable":true},"label":{"type":"string"},"description":{"type":"string","nullable":true},"property_type":{"type":"string","enum":["text","textarea","number","date","datetime","boolean","select","multi_select","url","email","phone","json"]},"options":{"type":"array","items":{"type":"string"}},"validation_rules":{"type":"object"},"display_order":{"type":"integer"},"is_visible":{"type":"boolean"},"is_searchable":{"type":"boolean"},"is_highlight":{"type":"boolean"},"help_text":{"type":"string"},"placeholder":{"type":"string"}}},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string"},"property_type":{"type":"string","enum":["text","textarea","number","date","datetime","boolean","select","multi_select","url","email","phone","json"]},"options":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"display_order":{"type":"integer"}}},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"object","required":["properties"],"properties":{"properties":{"type":"object","example":{"lead_score":92}}}},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"object","required":["key"],"properties":{"key":{"type":"string","example":"industry"},"value":{"type":"string","example":"SaaS"},"operator":{"type":"string","enum":["=","exists","contains"],"default":"="}}},"id":"schema_441"}},"exampleStore":{"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/simple":{"value":{"to":"user@example.com","subject":"Welcome to our platform!","html":"<h1>Welcome!</h1><p>Thanks for signing up.</p>","text":"Welcome! Thanks for signing up."},"key":"simple","summary":"Simple email","id":"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/simple"},"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/full":{"value":{"domain":"mail.yourdomain.com","from":"hello@mail.yourdomain.com","to":"user@example.com","reply_to":"support@yourdomain.com","cc":["manager@example.com"],"bcc":["archive@yourdomain.com"],"subject":"Your order has shipped!","html":"<h1>Order #12345 Shipped</h1><p>Track your package: <a href='https://track.example.com'>Click here</a></p>","text":"Order #12345 Shipped. Track your package at: https://track.example.com","track_opens":true,"track_clicks":true,"stream_type":"transactional","tag":"order-shipped","headers":{"X-Order-ID":"12345"},"metadata":{"order_id":"12345","customer_tier":"premium"}},"key":"full","summary":"Full-featured email with stream routing","id":"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/full"},"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/broadcast":{"value":{"from":"newsletter@mail.yourdomain.com","to":"subscriber@example.com","subject":"New Products This Week!","html":"<h1>Check out our latest products</h1><p>Special offer inside!</p>","text":"Check out our latest products. Special offer inside!","stream_type":"broadcast","tag":"weekly-newsletter","track_opens":true,"track_clicks":true},"key":"broadcast","summary":"Marketing campaign email","id":"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/broadcast"},"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/with_attachments":{"value":{"from":"billing@yourdomain.com","to":"customer@example.com","subject":"Invoice #12345 - January 2025","html":"<div><h2>Your Invoice is Ready</h2><p>Please find your invoice attached.</p><ul><li>Invoice: #12345</li><li>Amount: $1,250.00</li><li>Due: Feb 10, 2025</li></ul></div>","text":"Your invoice #12345 is attached. Amount: $1,250.00. Due: Feb 10, 2025.","stream_type":"transactional","tag":"invoice","attachments":[{"filename":"invoice-12345.pdf","content":"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL1BhZ2VzL0tpZHNbNCAwIFJdL0NvdW50IDEvTWVkaWFCb3ggWzAgMCA2MTIgNzkyXT4+CmVuZG9iago0IDAgb2JqCjw8L1R5cGUvUGFnZS9QYXJlbnQgMyAwIFI+PgplbmRvYmoKdHJhaWxlcgo8PC9TaXplIDUvUm9vdCAxIDAgUj4+CnN0YXJ0eHJlZgo0MTAKY0VPRg==","contentType":"application/pdf"}]},"key":"with_attachments","summary":"Email with PDF attachment","id":"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/with_attachments"},"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/calendar_invite":{"value":{"from":"manager@yourdomain.com","to":"employee@example.com","subject":"Meeting: Q1 Planning Review","html":"<div><h2>Q1 Planning Meeting</h2><p>You're invited to our quarterly planning session.</p><p><strong>When:</strong> Tomorrow at 2:00 PM</p><p><strong>Where:</strong> Conference Room A</p><p><strong>Duration:</strong> 1 hour</p></div>","text":"Q1 Planning Meeting - Tomorrow at 2:00 PM in Conference Room A (1 hour)","stream_type":"transactional","tag":"meeting-invite","icalEvent":"BEGIN:VCALENDAR\nVERSION:2.0\nPRODID:-//YourCompany//Meetings//EN\nMETHOD:REQUEST\nCALSCALE:GREGORIAN\nBEGIN:VEVENT\nUID:meeting-20250128-140000@yourdomain.com\nDTSTAMP:20250127T120000Z\nDTSTART:20250128T140000Z\nDTEND:20250128T150000Z\nSUMMARY:Q1 Planning Review\nDESCRIPTION:Quarterly planning session to review Q1 goals and budget\nLOCATION:Conference Room A\nORGANIZER;CN=Manager:mailto:manager@yourdomain.com\nATTENDEE;CN=Employee;RSVP=TRUE;PARTSTAT=NEEDS-ACTION:mailto:employee@example.com\nSTATUS:CONFIRMED\nSEQUENCE:0\nBEGIN:VALARM\nTRIGGER:-PT15M\nACTION:DISPLAY\nDESCRIPTION:Meeting reminder\nEND:VALARM\nEND:VEVENT\nEND:VCALENDAR"},"key":"calendar_invite","summary":"Calendar meeting invite","id":"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/calendar_invite"},"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/combined":{"value":{"from":"manager@yourdomain.com","to":"team@example.com","subject":"Meeting Tomorrow + Agenda Attached","html":"<div><h2>Team Meeting</h2><p>Meeting tomorrow at 2 PM. Please review the attached agenda before the meeting.</p></div>","text":"Team meeting tomorrow at 2 PM. Agenda attached.","stream_type":"transactional","tag":"team-meeting","icalEvent":"BEGIN:VCALENDAR\nVERSION:2.0\nPRODID:-//YourCompany//Meetings//EN\nMETHOD:REQUEST\nCALSCALE:GREGORIAN\nBEGIN:VEVENT\nUID:meeting-20250128-140000@yourdomain.com\nDTSTAMP:20250127T120000Z\nDTSTART:20250128T140000Z\nDTEND:20250128T150000Z\nSUMMARY:Team Meeting\nDESCRIPTION:Weekly team sync\nLOCATION:Conference Room A\nORGANIZER;CN=Manager:mailto:manager@yourdomain.com\nATTENDEE;CN=Team Member;RSVP=TRUE:mailto:team@example.com\nSTATUS:CONFIRMED\nEND:VEVENT\nEND:VCALENDAR","attachments":[{"filename":"agenda.pdf","content":"JVBERi0xLjQKJeLjz9MK...","contentType":"application/pdf"}]},"key":"combined","summary":"Calendar invite with attachments","id":"paths/~1api~1v1~1send/post/requestBody/content/application~1json/examples/combined"},"paths/~1api~1v1~1send/post/responses/200/content/application~1json/example":{"value":{"to":"user@example.com","submitted_at":"2024-03-15T14:30:00Z","message_id":"<550e8400-e29b-41d4-a716-446655440000@mail.yourdomain.com>","email_id":"550e8400-e29b-41d4-a716-446655440000","status":"queued","message":"Email queued for delivery","stream_type":"transactional","stream_reclassified":false,"stream_reclassification_reason":null},"id":"paths/~1api~1v1~1send/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/missing_fields":{"value":{"error":"Missing required fields","required":["to","subject"],"message":"to and subject are required"},"key":"missing_fields","summary":"Missing required fields","id":"paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/missing_fields"},"paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/invalid_email":{"value":{"error":"Invalid email address","message":"The \"to\" field must be a valid email address"},"key":"invalid_email","summary":"Invalid email address","id":"paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/invalid_email"},"paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/domain_mismatch":{"value":{"error":"From domain mismatch","message":"The \"from\" email must use the sending domain: mail.yourdomain.com"},"key":"domain_mismatch","summary":"From domain mismatch","id":"paths/~1api~1v1~1send/post/responses/400/content/application~1json/examples/domain_mismatch"},"paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/account_paused":{"value":{"error":"Customer account paused","reason":"Payment overdue","message":"Your account has been paused. Please contact support."},"key":"account_paused","summary":"Customer account paused","id":"paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/account_paused"},"paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/domain_not_verified":{"value":{"error":"Domain not verified","message":"Domain \"mail.yourdomain.com\" must be verified before sending emails"},"key":"domain_not_verified","summary":"Domain not verified","id":"paths/~1api~1v1~1send/post/responses/403/content/application~1json/examples/domain_not_verified"},"paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/customer_not_found":{"value":{"error":"Customer not found","message":"No customer found with id: 550e8400-e29b-41d4-a716-446655440000"},"key":"customer_not_found","summary":"Customer not found","id":"paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/customer_not_found"},"paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/domain_not_found":{"value":{"error":"Domain not found","message":"Domain \"mail.yourdomain.com\" not found or not verified. Add and verify your domain first."},"key":"domain_not_found","summary":"Domain not found","id":"paths/~1api~1v1~1send/post/responses/404/content/application~1json/examples/domain_not_found"},"paths/~1api~1v1~1send/post/responses/500/content/application~1json/example":{"value":{"error":"Internal server error","message":"Failed to process email send request"},"id":"paths/~1api~1v1~1send/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1batch/post/requestBody/content/application~1json/example":{"value":{"emails":[{"to":"user1@example.com","subject":"Order #12345 Confirmed","html":"<h1>Thanks for your order!</h1><p>Order #12345</p>","text":"Thanks for your order! Order #12345","tag":"order-confirmation","stream_type":"transactional","metadata":{"order_id":"12345"}},{"to":"user2@example.com","subject":"Password Reset Request","html":"<h1>Reset Password</h1><p><a href='https://...'>Click here</a></p>","text":"Reset your password: https://...","tag":"password-reset","stream_type":"transactional"},{"to":"user3@example.com","from":"welcome@mail.yourdomain.com","from_name":"Welcome Team","subject":"Welcome to our platform!","html":"<h1>Welcome!</h1>","text":"Welcome!","tag":"welcome","stream_type":"transactional"}]},"id":"paths/~1api~1v1~1batch/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/all_success":{"value":{"total":2,"queued":2,"failed":0,"results":[{"index":0,"to":"user1@example.com","email_id":"550e8400-e29b-41d4-a716-446655440000","message_id":"<550e8400-e29b-41d4-a716-446655440000@mail.yourdomain.com>","status":"queued"},{"index":1,"to":"user2@example.com","email_id":"650e8400-e29b-41d4-a716-446655440001","message_id":"<650e8400-e29b-41d4-a716-446655440001@mail.yourdomain.com>","status":"queued"}]},"key":"all_success","summary":"All emails queued","id":"paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/all_success"},"paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/partial_success":{"value":{"total":3,"queued":2,"failed":1,"results":[{"index":0,"to":"user1@example.com","email_id":"550e8400-e29b-41d4-a716-446655440000","message_id":"<550e8400-e29b-41d4-a716-446655440000@mail.yourdomain.com>","status":"queued"},{"index":2,"to":"user3@example.com","email_id":"750e8400-e29b-41d4-a716-446655440002","message_id":"<750e8400-e29b-41d4-a716-446655440002@mail.yourdomain.com>","status":"queued"}],"errors":[{"index":1,"email":"invalid-email","error":"Invalid email address"}]},"key":"partial_success","summary":"Partial success (some failed).","id":"paths/~1api~1v1~1batch/post/responses/200/content/application~1json/examples/partial_success"},"paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/missing_fields":{"value":{"error":"Missing required field","message":"emails array is required"},"key":"missing_fields","summary":"Missing required fields","id":"paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/missing_fields"},"paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/batch_size_exceeded":{"value":{"error":"Batch size exceeded","message":"Maximum 500 emails per batch. Use multiple requests for larger batches."},"key":"batch_size_exceeded","summary":"Too many emails","id":"paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/batch_size_exceeded"},"paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/all_failed":{"value":{"total":2,"queued":0,"failed":2,"errors":[{"index":0,"email":"user1@example.com","error":"Missing subject field"},{"index":1,"email":"user2@example.com","error":"Domain not verified"}]},"key":"all_failed","summary":"All emails failed","id":"paths/~1api~1v1~1batch/post/responses/400/content/application~1json/examples/all_failed"},"paths/~1api~1v1~1batch/post/responses/403/content/application~1json/example":{"value":{"error":"Customer account paused","reason":"Payment overdue","message":"Your account has been paused. Please contact support."},"id":"paths/~1api~1v1~1batch/post/responses/403/content/application~1json/example"},"paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/customer_not_found":{"value":{"error":"Customer not found","message":"No customer found with id: 550e8400-e29b-41d4-a716-446655440000"},"key":"customer_not_found","summary":"Customer not found","id":"paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/customer_not_found"},"paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/no_verified_domains":{"value":{"error":"No verified domains","message":"No verified sending domains found. Add and verify a domain first."},"key":"no_verified_domains","summary":"No verified domains","id":"paths/~1api~1v1~1batch/post/responses/404/content/application~1json/examples/no_verified_domains"},"paths/~1api~1v1~1batch/post/responses/429/content/application~1json/example":{"value":{"error":"DAILY_LIMIT_EXCEEDED","message":"This batch would exceed your daily send limit of 200 (sent/reserved today: 150).","batch_size":100,"daily_limit":200,"reserved_today":150},"id":"paths/~1api~1v1~1batch/post/responses/429/content/application~1json/example"},"paths/~1api~1v1~1batch/post/responses/500/content/application~1json/example":{"value":{"error":"Internal server error","message":"Failed to process batch send request"},"id":"paths/~1api~1v1~1batch/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1bulk-send/post/responses/202/content/application~1json/example":{"value":{"message":"Emails queued for delivery","queued":2,"errors":0,"campaign_id":"f1e2d3c4-b5a6-7890-cdef-123456789abc","bulk_session_id":"f1e2d3c4-b5a6-7890-cdef-123456789abc","jobs":[{"email":"john@example.com","jobId":"job123","emailId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","campaignId":"f1e2d3c4-b5a6-7890-cdef-123456789abc"},{"email":"jane@example.com","jobId":"job124","emailId":"b2c3d4e5-f6a7-8901-bcde-f12345678901","campaignId":"f1e2d3c4-b5a6-7890-cdef-123456789abc"}]},"id":"paths/~1api~1v1~1bulk-send/post/responses/202/content/application~1json/example"},"paths/~1api~1v1~1bulk-send/post/responses/400/content/application~1json/example":{"value":{"error":"Validation failed","message":"subject is required"},"id":"paths/~1api~1v1~1bulk-send/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1bulk-send/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1bulk-send/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1bulk-send/post/responses/500/content/application~1json/example":{"value":{"error":"Internal server error","message":"Failed to process bulk send request"},"id":"paths/~1api~1v1~1bulk-send/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1send-segment/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1send-segment/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/basic_test":{"value":{"domain_id":"d1234567-e89b-12d3-a456-426614174000","from":"test@mail.example.com","to":"you@gmail.com","subject":"Test Email","text":"This is a test email.","test_mode":"basic","analyze_content":true},"key":"basic_test","summary":"Basic test (new domain)","id":"paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/basic_test"},"paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/standard_test":{"value":{"domain_id":"d1234567-e89b-12d3-a456-426614174000","from":"test@mail.example.com","to":"you@gmail.com","subject":"Test Email","html":"<p>This is a test email with <a href='https://example.com'>a link</a>.</p>","text":"This is a test email with a link.","test_mode":"standard"},"key":"standard_test","summary":"Standard test with HTML","id":"paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/standard_test"},"paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/full_test":{"value":{"domain_id":"d1234567-e89b-12d3-a456-426614174000","from":"test@mail.example.com","to":"you@gmail.com","subject":"Test Email","html":"<p>This is a test email.</p>","track_opens":true,"track_clicks":true,"test_mode":"full"},"key":"full_test","summary":"Full test with all tracking","id":"paths/~1api~1v1~1customer~1test-email/post/requestBody/content/application~1json/examples/full_test"},"paths/~1api~1v1~1customer~1test-email/post/responses/201/content/application~1json/example":{"value":{"message":"Test email queued successfully","email":{"id":"e1234567-e89b-12d3-a456-426614174000","from":"test@mail.example.com","to":"you@gmail.com","subject":"Test Email","domain":"mail.example.com","message_id":"<uuid@mail.example.com>","status":"queued","tracking":{"opens":false,"clicks":false}},"domain_info":{"age_in_days":3,"has_custom_tracking":false},"warnings":[{"type":"new_domain","severity":"high","message":"Domain is only 3 days old","recommendation":"First emails from new domains often land in spam. Mark as 'Not Spam' if needed."},{"type":"tracking_disabled","severity":"info","message":"Tracking disabled in basic mode for better deliverability"}],"content_analysis":{"basic_check_performed":true,"spam_words_found":0,"note":"For detailed content scoring and analysis, use POST /api/content-score (subject to tier limits)"},"next_steps":["Check your inbox and mark the email as 'Not Spam' if it lands in spam","Send 2-3 more test emails to trusted addresses today","Gradually increase sending volume over the next 2 weeks","Monitor your domain health score regularly","Consider setting up a custom tracking domain to improve deliverability"]},"id":"paths/~1api~1v1~1customer~1test-email/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1customer~1test-email/post/responses/400/content/application~1json/example":{"value":{"error":"Invalid domain name"},"id":"paths/~1api~1v1~1customer~1test-email/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1test-email/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1test-email/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1test-email/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1test-email/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1test-email/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1test-email/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1test-deliverability/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1test-deliverability/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1report/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1opened/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1clicked/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1bounced/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1contacts~1failed/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1recipients/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1opens/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1timeline~1clicks/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1campaigns~1{campaignId}~1links/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1profile/get/responses/200/content/application~1json/example":{"value":{"customer":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Acme Corp","email":"api@acme.com","status":"active","monthly_email_limit":100000,"max_domains":5,"webhook_endpoints_limit":10,"tracking_enabled":true,"click_tracking_enabled":true,"open_tracking_enabled":true,"block_disposable_emails":true,"enforce_sender_verification":true,"created_at":"2024-01-15T10:30:00Z","current_domains":3,"emails_sent_this_month":45230,"remaining_emails":54770}},"id":"paths/~1api~1v1~1customer~1profile/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1profile/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1profile/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1profile/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1profile/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1profile/put/requestBody/content/application~1json/example":{"value":{"name":"Acme Corporation"},"id":"paths/~1api~1v1~1customer~1profile/put/requestBody/content/application~1json/example"},"paths/~1api~1v1~1customer~1profile/put/responses/400/content/application~1json/example":{"value":{"error":"Invalid domain name"},"id":"paths/~1api~1v1~1customer~1profile/put/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1profile/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1profile/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1profile/put/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1profile/put/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1rotate-key/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1rotate-key/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1rotate-key/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1rotate-key/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1smtp-credentials/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials/post/responses/201/content/application~1json/example":{"value":{"credential":{"id":"550e8400-e29b-41d4-a716-446655440001","name":"Production Transactional","username":"ml_smtp_1f2961f48a99c8e2","status":"active","is_master":false,"sending_domain":null,"daily_limit":5000,"monthly_limit":100000,"daily_sent":0,"monthly_sent":0},"plain_password":"smtp_a1b2c3d4e5f6789abcdef..."},"id":"paths/~1api~1v1~1smtp-credentials/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1smtp-credentials/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/404/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}/put/responses/500/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1rotate/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1smtp-credentials~1{credential_id}~1status/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1hostnames/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1hostnames/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/verified":{"value":{"verified":true,"hostname":"smtp.yourdomain.com","expected_cname":"smtp.mailerlogic.net","message":"DNS verified successfully. SSL certificate will be issued automatically."},"key":"verified","summary":"DNS verified","id":"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/verified"},"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/pending":{"value":{"verified":false,"hostname":"smtp.yourdomain.com","expected_cname":"smtp.mailerlogic.net","message":"CNAME not found yet. Ensure smtp.yourdomain.com → smtp.mailerlogic.net is set."},"key":"pending","summary":"CNAME not yet found","id":"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/200/content/application~1json/examples/pending"},"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1smtp-credentials~1hostnames~1{hostname_id}~1verify/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1smtp-credentials~1rotate/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains/get/responses/200/content/application~1json/example":{"value":{"domains":[{"id":"d1234567-e89b-12d3-a456-426614174000","domain":"mail.acme.com","verification_status":"verified","security_status":"active","sending_allowed":true,"dkim_selector":"mail","spf_record":"v=spf1 ip4:1.2.3.4 ~all","dmarc_record":"v=DMARC1; p=quarantine; rua=mailto:dmarc@mail.acme.com","is_active":true,"tags":["production","transactional"],"created_at":"2024-01-15T10:30:00Z","verified_at":"2024-01-15T11:00:00Z","tracking_domain_id":"bed913d9-891f-4f5f-9881-7d71a2145a93","assignment_type":"explicit","tracking_domain_info":{"tracking_domain":"track.acme.com","is_verified":true},"tracking_enabled":null,"open_tracking_enabled":false,"click_tracking_enabled":null,"unsubscribe_header_enabled":null}]},"id":"paths/~1api~1v1~1customer~1domains/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/200/content/application~1json/example":{"value":{"domain":"mail.acme.com","dns_records":[{"type":"TXT","name":"_domainverify.mail.acme.com","value":"a1b2c3d4e5f6g7h8","description":"Domain verification record"},{"type":"TXT","name":"mail.acme.com","value":"v=spf1 ip4:1.2.3.4 ~all","description":"SPF record for email authentication"},{"type":"TXT","name":"mail._domainkey.mail.acme.com","value":"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3...","description":"DKIM public key"},{"type":"TXT","name":"_dmarc.mail.acme.com","value":"v=DMARC1; p=quarantine; rua=mailto:dmarc@mail.acme.com","description":"DMARC policy"},{"type":"CNAME","name":"bounce.mail.acme.com","value":"bounces.mailerlogic.io","description":"Bounce subdomain - Routes bounce emails (eliminates 'via' label in Gmail)"}]},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1dns/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/success":{"value":{"verified":true,"status":"verified","results":{"domain_verification":true,"spf":true,"dkim":true,"dmarc":true,"bounce_cname":{"valid":true,"optional":true,"message":"Bounce CNAME record found and matches"}},"message":"Domain verified successfully!"},"key":"success","summary":"success","id":"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/success"},"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed":{"value":{"verified":false,"status":"failed","results":{"domain_verification":true,"spf":true,"dkim":false,"dmarc":true,"bounce_cname":{"valid":false,"optional":true,"message":"No CNAME record found for bounce subdomain"}},"message":"Verification failed. Please check your DNS records."},"key":"failed","summary":"failed","id":"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"},"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1verify/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_all_tracking":{"value":{"tracking_enabled":false},"key":"disable_all_tracking","summary":"Disable all tracking for this domain","id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_all_tracking"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_opens_only":{"value":{"open_tracking_enabled":false,"click_tracking_enabled":true},"key":"disable_opens_only","summary":"Disable open tracking, keep click tracking","id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/disable_opens_only"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/reset_to_defaults":{"value":{"tracking_enabled":null,"open_tracking_enabled":null,"click_tracking_enabled":null,"unsubscribe_header_enabled":null},"key":"reset_to_defaults","summary":"Reset to customer defaults","id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/requestBody/content/application~1json/examples/reset_to_defaults"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/200/content/application~1json/example":{"value":{"id":"d1234567-e89b-12d3-a456-426614174000","domain":"transactional.acme.com","tracking_enabled":null,"open_tracking_enabled":false,"click_tracking_enabled":false,"unsubscribe_header_enabled":true,"updated_at":"2026-01-16T10:30:00Z"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/400/content/application~1json/example":{"value":{"error":"Invalid domain name"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/patch/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}/delete/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/200/content/application~1json/example":{"value":{"tracking_enabled":null,"open_tracking_enabled":false,"click_tracking_enabled":null,"unsubscribe_header_enabled":null,"account_defaults":{"tracking_enabled":true,"open_tracking_enabled":true,"click_tracking_enabled":true,"unsubscribe_header_enabled":true},"is_in_sandbox":false,"sandbox_message":null},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_open_tracking_only":{"value":{"open_tracking_enabled":false},"key":"disable_open_tracking_only","summary":"Disable open tracking, keep everything else inherited","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_open_tracking_only"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/reset_all_to_account_defaults":{"value":{"tracking_enabled":null,"open_tracking_enabled":null,"click_tracking_enabled":null,"unsubscribe_header_enabled":null},"key":"reset_all_to_account_defaults","summary":"Reset all overrides — inherit everything from account","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/reset_all_to_account_defaults"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_all_tracking":{"value":{"tracking_enabled":false},"key":"disable_all_tracking","summary":"Disable all tracking for this domain (trusted accounts only)","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/requestBody/content/application~1json/examples/disable_all_tracking"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking/patch/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/200/content/application~1json/example":{"value":{"domain_id":"d1234567-e89b-12d3-a456-426614174000","domain":"mail.example.com","age_in_days":3,"verification_status":"verified","health_score":45,"health_grade":"D","stats":{"total_sent":0,"delivered":0,"bounced":0,"spam":0,"spam_rate":0},"has_custom_tracking_domain":false,"test_mode_recommended":"basic","ready_to_send":false,"warnings":[{"type":"new_domain","severity":"high","message":"Domain is only 3 days old","recommendation":"Use basic test mode without tracking. First emails from new domains often land in spam.","action":"disable_tracking"},{"type":"no_custom_tracking","severity":"medium","message":"No custom tracking domain configured","recommendation":"Set up a custom tracking domain to improve deliverability.","action":"setup_tracking_domain"}],"checklist":{"dns_verified":true,"domain_age_ok":false,"has_sends":false,"low_spam_rate":true,"has_custom_tracking":false,"healthy_score":false},"recommendations":{"basic":{"name":"Basic Connectivity Test","description":"Plain text only, no tracking, no links","recommended_for":"New domains (< 7 days) or first email","features":{"tracking":false,"html":false,"links":false}},"standard":{"name":"Standard Test","description":"HTML content, minimal tracking","recommended_for":"Domains 7-30 days with some sending history"},"full":{"name":"Full Feature Test","description":"All features enabled","recommended_for":"Established domains (> 30 days) with good reputation"}}},"id":"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1test-readiness~1{domain_id}/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/assign_tracking_domain":{"value":{"tracking_domain_id":"bed913d9-891f-4f5f-9881-7d71a2145a93"},"key":"assign_tracking_domain","summary":"Assign tracking domain","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/assign_tracking_domain"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/clear_assignment":{"value":{"tracking_domain_id":null},"key":"clear_assignment","summary":"Clear assignment (use smart matching)","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/requestBody/content/application~1json/examples/clear_assignment"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/assigned":{"value":{"success":true,"message":"Tracking domain assigned successfully","assignment":{"domain_id":"950b0d83-a6b5-408e-831c-e753c879b876","domain":"mail.example.com","tracking_domain_id":"bed913d9-891f-4f5f-9881-7d71a2145a93","tracking_domain":"track.example.com"}},"key":"assigned","summary":"Successfully assigned","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/assigned"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/cleared":{"value":{"success":true,"message":"Tracking domain assignment cleared. Smart matching will be used.","assignment":{"domain_id":"950b0d83-a6b5-408e-831c-e753c879b876","domain":"mail.example.com","tracking_domain_id":null,"tracking_domain":null}},"key":"cleared","summary":"Assignment cleared","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/200/content/application~1json/examples/cleared"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/400/content/application~1json/examples/not_verified":{"value":{"error":"Tracking domain not verified","message":"Can only assign verified tracking domains. Please verify the tracking domain first."},"key":"not_verified","summary":"Tracking domain not verified","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/400/content/application~1json/examples/not_verified"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/domain_not_found":{"value":{"error":"Domain not found","message":"Sending domain not found or does not belong to this customer"},"key":"domain_not_found","summary":"Sending domain not found","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/domain_not_found"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/tracking_not_found":{"value":{"error":"Tracking domain not found","message":"Tracking domain not found or does not belong to this customer"},"key":"tracking_not_found","summary":"Tracking domain not found","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/404/content/application~1json/examples/tracking_not_found"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/put/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/explicit_assignment":{"value":{"domain_id":"950b0d83-a6b5-408e-831c-e753c879b876","domain":"mail.example.com","assignment":{"tracking_domain_id":"bed913d9-891f-4f5f-9881-7d71a2145a93","tracking_domain":"track.example.com","is_verified":true,"assignment_type":"explicit"}},"key":"explicit_assignment","summary":"Explicit assignment","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/explicit_assignment"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/smart_matching":{"value":{"domain_id":"950b0d83-a6b5-408e-831c-e753c879b876","domain":"mail.example.com","assignment":{"tracking_domain_id":null,"tracking_domain":null,"is_verified":null,"assignment_type":"smart_matching"}},"key":"smart_matching","summary":"Smart matching (no explicit assignment)","id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/200/content/application~1json/examples/smart_matching"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1domains~1{id}~1tracking-domain/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains/post/requestBody/content/application~1json/examples/basic":{"value":{"domain":"track.yourdomain.com"},"key":"basic","summary":"Create tracking domain","id":"paths/~1api~1v1~1customer~1tracking-domains/post/requestBody/content/application~1json/examples/basic"},"paths/~1api~1v1~1customer~1tracking-domains/post/responses/201/content/application~1json/example":{"value":{"id":"550e8400-e29b-41d4-a716-446655440000","domain":"track.yourdomain.com","cname_target":"track.mailerlogic.net","is_verified":false,"ssl_enabled":false,"created_at":"2026-01-23T10:00:00.000Z","dns_setup":{"record_type":"CNAME","hostname":"track.yourdomain.com","value":"track.mailerlogic.net","instructions":"Add a CNAME record in your DNS settings pointing track.yourdomain.com to track.mailerlogic.net"}},"id":"paths/~1api~1v1~1customer~1tracking-domains/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains/post/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1customer~1tracking-domains/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains/get/responses/200/content/application~1json/example":{"value":{"tracking_domains":[{"id":"550e8400-e29b-41d4-a716-446655440000","domain":"track.yourdomain.com","cname_target":"track.mailerlogic.net","is_verified":true,"verified_at":"2026-01-23T10:05:00.000Z","ssl_enabled":true,"created_at":"2026-01-23T10:00:00.000Z","https_url":"https://track.yourdomain.com"},{"id":"660e9511-f30c-52e5-b827-557766551111","domain":"link.yourdomain.com","cname_target":"track.mailerlogic.net","is_verified":false,"verified_at":null,"ssl_enabled":false,"created_at":"2026-01-23T11:00:00.000Z","https_url":null}]},"id":"paths/~1api~1v1~1customer~1tracking-domains/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/200/content/application~1json/example":{"value":{"id":"550e8400-e29b-41d4-a716-446655440000","domain":"track.yourdomain.com","cname_target":"track.mailerlogic.net","is_verified":true,"verified_at":"2026-01-23T10:05:00.000Z","ssl_enabled":true,"created_at":"2026-01-23T10:00:00.000Z","https_url":"https://track.yourdomain.com","dns_setup":{"record_type":"CNAME","hostname":"track.yourdomain.com","value":"track.mailerlogic.net","instructions":"Add a CNAME record in your DNS settings pointing track.yourdomain.com to track.mailerlogic.net"}},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/patch/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}/delete/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/verified":{"value":{"verified":true,"domain":"track.yourdomain.com","cname_target":"track.mailerlogic.net","dns_records":["track.mailerlogic.net"],"message":"Tracking domain verified successfully! SSL certificate is being generated automatically.","ssl":{"status":"provisioning","message":"SSL certificate generation started. This typically takes 1-2 minutes.","enabled":false},"next_steps":["Wait 1-2 minutes for SSL certificate generation","Test your tracking domain: https://track.yourdomain.com/track/o/test","Check SSL status using GET /api/v1/customer/tracking-domains/:id/ssl"]},"key":"verified","summary":"Domain verified successfully","id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/verified"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed":{"value":{"verified":false,"domain":"track.yourdomain.com","cname_target":"track.mailerlogic.net","dns_records":[],"message":"CNAME record not found. Please add the CNAME record and wait 5-30 minutes for DNS propagation.","ssl":{"status":"not_available","message":"Domain must be verified before SSL can be enabled","enabled":false},"next_steps":["Add the CNAME record in your DNS provider","Wait 5-30 minutes for DNS propagation","Retry verification"]},"key":"failed","summary":"Verification failed","id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/200/content/application~1json/examples/failed"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1verify/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/active":{"value":{"status":"active","enabled":true,"https_url":"https://track.yourdomain.com","message":"SSL certificate is active and working","domain":"track.yourdomain.com","certificate":{"issuer":"Let's Encrypt","auto_renewal":true}},"key":"active","summary":"SSL certificate active","id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/active"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/provisioning":{"value":{"status":"provisioning","enabled":false,"https_url":null,"message":"SSL certificate is being generated. This typically takes 1-2 minutes.","domain":"track.yourdomain.com","certificate":null,"next_steps":["Wait a few more minutes","Check status again","Test: https://track.yourdomain.com/track/o/test"]},"key":"provisioning","summary":"SSL provisioning in progress","id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/provisioning"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/unavailable":{"value":{"status":"unavailable","enabled":false,"https_url":null,"message":"Domain must be verified before SSL can be enabled","domain":"track.yourdomain.com","certificate":null},"key":"unavailable","summary":"Domain not verified","id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/200/content/application~1json/examples/unavailable"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/202/content/application~1json/example":{"value":{"status":"provisioning","message":"SSL certificate generation initiated. This typically takes 30-60 seconds.","domain":"track.yourdomain.com","https_url":"https://track.yourdomain.com","next_steps":["Wait 60 seconds for certificate generation","Test HTTPS URL: https://track.yourdomain.com/track/o/test","Check status: GET /api/v1/customer/tracking-domains/:id/ssl","Certificate will auto-renew before expiration"],"troubleshooting":{"verify_dns":"Ensure CNAME record is set: track.yourdomain.com → track.mailerlogic.net","check_propagation":"DNS propagation may take 5-30 minutes","test_http":"Test HTTP first: http://track.yourdomain.com/.well-known/acme-challenge/test"}},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/202/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1tracking-domains~1{id}~1ssl/post/responses/500/content/application~1json/example"},"paths/~1api~1v1~1customer~1usage/get/responses/200/content/application~1json/example":{"value":{"current_month":{"emails_sent":45230,"emails_delivered":44850,"emails_bounced":280,"emails_complained":15,"emails_opened":22000,"emails_clicked":8500,"delivery_rate":"99.16","bounce_rate":"0.62"},"limits":{"monthly_limit":100000,"remaining":54770,"used_percentage":"45.23"}},"id":"paths/~1api~1v1~1customer~1usage/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1usage/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1usage/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1usage/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1customer~1usage/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1sends/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound~1sends/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1sends/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound~1sends/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound~1delivered/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound~1bounces/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1spam/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound~1spam/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1spam/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound~1spam/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1opens/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound~1opens/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1opens/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound~1opens/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/200/content/application~1json/example":{"value":{"platforms":[{"name":"Gmail","count":12500},{"name":"Apple Mail","count":8200},{"name":"Outlook","count":6100},{"name":"Unknown","count":1200}]},"id":"paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound~1opens~1platforms/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1stats~1outbound~1clicks/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1content-score/post/responses/200/content/application~1json/example":{"value":{"status":"ok","score":92,"risk_level":"low","matches":[{"rule_code":"EXCESSIVE_CAPS","severity":"low","category":"formatting","message":"Subject line contains excessive capital letters","location":"subject"}],"suggestions":["Reduce capitalization in subject line","Add a plain-text version of your email"],"usage":{"used":145,"limit":1000,"period":"monthly"}},"id":"paths/~1api~1v1~1content-score/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/valid_email":{"value":{"email":"john.smith@company.com","is_valid":true,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":false,"is_role_account":false,"mailbox_exists":true,"is_catch_all":false,"smtp_check_performed":true},"risk_level":"low","deliverability_score":95,"confidence_score":97,"confidence_label":"very_high","mx_provider":{"name":"google","tier":"enterprise"},"email_pattern":"human_name","suggestions":[],"usage":{"used":145,"limit":1000,"remaining":855}},"key":"valid_email","summary":"Valid email (mailbox confirmed, Google Workspace)","id":"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/valid_email"},"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_enterprise":{"value":{"email":"efrain.fernandez@stryker.com","is_valid":true,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":false,"is_role_account":false,"mailbox_exists":null,"is_catch_all":true,"smtp_check_performed":true},"risk_level":"low","deliverability_score":95,"confidence_score":72,"confidence_label":"high","mx_provider":{"name":"microsoft","tier":"enterprise"},"email_pattern":"human_name","suggestions":["Catch-all domain detected with a reputable mail provider. Email may be deliverable but cannot be individually verified."],"usage":{"used":146,"limit":1000,"remaining":854}},"key":"catch_all_enterprise","summary":"Catch-all domain — enterprise provider (medium confidence)","id":"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_enterprise"},"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_unknown":{"value":{"email":"user@small-hosting.com","is_valid":true,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":false,"is_role_account":false,"mailbox_exists":null,"is_catch_all":true,"smtp_check_performed":true},"risk_level":"medium","deliverability_score":75,"confidence_score":42,"confidence_label":"low","mx_provider":{"name":"custom","tier":"unknown"},"email_pattern":"generic","suggestions":["Catch-all domain detected. Email may be deliverable but cannot be individually verified."],"usage":{"used":147,"limit":1000,"remaining":853}},"key":"catch_all_unknown","summary":"Catch-all domain — unknown provider (low confidence)","id":"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/catch_all_unknown"},"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/mailbox_not_found":{"value":{"email":"nobody@validcompany.com","is_valid":false,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":false,"is_role_account":false,"mailbox_exists":false,"is_catch_all":false,"smtp_check_performed":true,"smtp_reason":"User unknown"},"risk_level":"high","deliverability_score":5,"confidence_score":0,"confidence_label":"very_low","mx_provider":{"name":"google","tier":"enterprise"},"email_pattern":"generic","suggestions":[],"reason":"Mailbox does not exist: User unknown","usage":{"used":148,"limit":1000,"remaining":852}},"key":"mailbox_not_found","summary":"Mailbox does not exist (SMTP rejected)","id":"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/mailbox_not_found"},"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/disposable_email":{"value":{"email":"temp@mailinator.com","is_valid":false,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":true,"disposable_source":"multiple_sources","disposable_confidence":100,"is_role_account":false,"mailbox_exists":null,"is_catch_all":null,"smtp_check_performed":false},"risk_level":"high","deliverability_score":20,"confidence_score":5,"confidence_label":"very_low","mx_provider":{"name":"custom","tier":"unknown"},"email_pattern":"random","suggestions":[],"reason":"Disposable email service detected","usage":{"used":149,"limit":1000,"remaining":851}},"key":"disposable_email","summary":"Disposable email detected","id":"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/disposable_email"},"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/no_mx_records":{"value":{"email":"user@no-email-domain.com","is_valid":false,"validation_checks":{"syntax_valid":true,"domain_exists":false,"has_mx_records":false,"is_disposable":false,"is_role_account":false,"mailbox_exists":null,"is_catch_all":null,"smtp_check_performed":false},"risk_level":"high","deliverability_score":10,"confidence_score":0,"confidence_label":"very_low","mx_provider":{"name":"none","tier":"none"},"email_pattern":"generic","suggestions":[],"reason":"Domain cannot receive email (no valid MX or A records)","usage":{"used":150,"limit":1000,"remaining":850}},"key":"no_mx_records","summary":"Domain has no MX records","id":"paths/~1api~1v1~1address~1validate/post/responses/200/content/application~1json/examples/no_mx_records"},"paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/missing_email":{"value":{"error":"Email address is required"},"key":"missing_email","summary":"missing_email","id":"paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/missing_email"},"paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/invalid_format":{"value":{"error":"Invalid email format"},"key":"invalid_format","summary":"invalid_format","id":"paths/~1api~1v1~1address~1validate/post/responses/400/content/application~1json/examples/invalid_format"},"paths/~1api~1v1~1address~1validate/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1address~1validate/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1address~1validate/post/responses/429/content/application~1json/example":{"value":{"error":"Monthly validation quota exceeded","usage":{"used":1000,"limit":1000,"remaining":0,"reset_date":"2025-01-01"}},"id":"paths/~1api~1v1~1address~1validate/post/responses/429/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch/post/responses/200/content/application~1json/example":{"value":{"total":3,"valid_count":2,"invalid_count":1,"results":[{"email":"john.smith@company.com","is_valid":true,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":false,"is_role_account":false,"mailbox_exists":true,"is_catch_all":false,"smtp_check_performed":true},"risk_level":"low","deliverability_score":95,"confidence_score":97,"confidence_label":"very_high","mx_provider":{"name":"google","tier":"enterprise"},"email_pattern":"human_name","suggestions":[]},{"email":"efrain.fernandez@stryker.com","is_valid":true,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":false,"is_role_account":false,"mailbox_exists":null,"is_catch_all":true,"smtp_check_performed":true},"risk_level":"low","deliverability_score":95,"confidence_score":72,"confidence_label":"high","mx_provider":{"name":"microsoft","tier":"enterprise"},"email_pattern":"human_name","suggestions":["Catch-all domain detected with a reputable mail provider. Email may be deliverable but cannot be individually verified."]},{"email":"temp@mailinator.com","is_valid":false,"validation_checks":{"syntax_valid":true,"domain_exists":true,"has_mx_records":true,"is_disposable":true,"disposable_source":"database","disposable_confidence":100,"is_role_account":false,"mailbox_exists":null,"is_catch_all":null,"smtp_check_performed":false},"risk_level":"high","deliverability_score":20,"confidence_score":5,"confidence_label":"very_low","mx_provider":{"name":"custom","tier":"unknown"},"email_pattern":"random","suggestions":[],"reason":"Disposable email service detected"}],"usage":{"used":153,"limit":1000,"remaining":847}},"id":"paths/~1api~1v1~1address~1validate~1batch/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch/post/responses/202/content/application~1json/example":{"value":{"job_id":"3b3f9d2e-7c1a-4f39-b1de-2b5c4a8e9f10","status":"queued","total":999,"status_url":"/api/v1/address/validate/batch/3b3f9d2e-7c1a-4f39-b1de-2b5c4a8e9f10","results_url":"/api/v1/address/validate/batch/3b3f9d2e-7c1a-4f39-b1de-2b5c4a8e9f10/results"},"id":"paths/~1api~1v1~1address~1validate~1batch/post/responses/202/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/empty_array":{"value":{"error":"At least one email is required"},"key":"empty_array","summary":"empty_array","id":"paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/empty_array"},"paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/too_many":{"value":{"error":"Maximum 1000 unique emails per batch request"},"key":"too_many","summary":"too_many","id":"paths/~1api~1v1~1address~1validate~1batch/post/responses/400/content/application~1json/examples/too_many"},"paths/~1api~1v1~1address~1validate~1batch/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1address~1validate~1batch/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch/post/responses/429/content/application~1json/example":{"value":{"error":"Monthly validation quota exceeded"},"id":"paths/~1api~1v1~1address~1validate~1batch/post/responses/429/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/200/content/application~1json/example":{"value":{"job_id":"3b3f9d2e-7c1a-4f39-b1de-2b5c4a8e9f10","status":"running","total":999,"processed":400,"progress_percent":40,"valid":350,"invalid":25,"risky":25,"failed":0,"chunk_count":20,"chunks_completed":8,"chunks_failed":0,"created_at":"2026-07-07T15:00:00.000Z","started_at":"2026-07-07T15:00:02.000Z","completed_at":null},"id":"paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/404/content/application~1json/example":{"value":{"error":"Not found"},"id":"paths/~1api~1v1~1address~1validate~1batch~1{jobId}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/404/content/application~1json/example":{"value":{"error":"Not found"},"id":"paths/~1api~1v1~1address~1validate~1batch~1{jobId}~1results/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1quota/get/responses/200/content/application~1json/example":{"value":{"validation_limit":1000,"validations_used":247,"validations_remaining":753,"period":"monthly","reset_date":"2025-01-01"},"id":"paths/~1api~1v1~1address~1validate~1quota/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1address~1validate~1quota/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1address~1validate~1quota/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/safe_send":{"value":{"risk_score":15,"risk_level":"safe","would_block":false,"action":"allow","reason_code":null,"block_reason":null,"risk_factors":[{"type":"free_email_provider","points":5,"message":"Sending to free email provider"}],"breakdown":{"recipient":5,"content":5,"sender":0,"behavior":0},"recommendations":[],"policy_snapshot":{"block_disposable_emails":true,"enforce_sender_verification":true,"disposable_confidence_threshold":0.85,"customer_plan":"professional"},"engine_version":"risk-v3.2","quota":{"used":43,"limit":1000,"remaining":957,"reset_at":"2025-02-01T00:00:00Z"}},"key":"safe_send","summary":"Safe to send","id":"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/safe_send"},"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/medium_risk_warning":{"value":{"risk_score":55,"risk_level":"medium","would_block":false,"action":"warn","reason_code":null,"block_reason":null,"risk_factors":[{"type":"disposable_medium_confidence","points":25,"message":"Disposable domain suspected (75% confidence)"},{"type":"sender_not_verified","points":20,"message":"Sender domain not verified"},{"type":"content_risk_medium","points":10,"message":"Some spam indicators detected"}],"breakdown":{"recipient":25,"content":10,"sender":20,"behavior":0},"recommendations":["Verify your sending domain with DKIM and SPF","Review content for spam trigger words","Consider cleaning your recipient list"],"policy_snapshot":{"block_disposable_emails":true,"enforce_sender_verification":false,"disposable_confidence_threshold":0.85,"customer_plan":"professional"},"engine_version":"risk-v3.2","quota":{"used":44,"limit":1000,"remaining":956,"reset_at":"2025-02-01T00:00:00Z"}},"key":"medium_risk_warning","summary":"Medium risk (customer can still send)","id":"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/medium_risk_warning"},"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_disposable":{"value":{"risk_score":40,"risk_level":"low","would_block":true,"action":"block","reason_code":"disposable_high_confidence","block_reason":"Disposable email domain detected with 95% confidence","risk_factors":[{"type":"disposable_high_confidence","points":40,"message":"Known disposable domain (temp-mail.org)"}],"breakdown":{"recipient":40,"content":0,"sender":0,"behavior":0},"recommendations":["Remove disposable domains from your list","Use email validation to clean your list"],"policy_snapshot":{"block_disposable_emails":true,"enforce_sender_verification":true,"disposable_confidence_threshold":0.85,"customer_plan":"professional"},"engine_version":"risk-v3.2","quota":{"used":45,"limit":1000,"remaining":955,"reset_at":"2025-02-01T00:00:00Z"}},"key":"hard_block_disposable","summary":"Hard block - High confidence disposable","id":"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_disposable"},"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_spamtrap":{"value":{"risk_score":40,"risk_level":"low","would_block":true,"action":"block","reason_code":"spamtrap_detected","block_reason":"Recipient blocked due to high risk profile","risk_factors":[{"type":"spamtrap_detected","points":40,"message":"High risk recipient detected"}],"breakdown":{"recipient":40,"content":0,"sender":0,"behavior":0},"recommendations":["Remove this address from your list immediately","Review your list acquisition and validation practices","Consider implementing double opt-in"],"policy_snapshot":{"block_disposable_emails":true,"enforce_sender_verification":true,"disposable_confidence_threshold":0.85,"customer_plan":"professional"},"engine_version":"risk-v3.2","quota":{"used":46,"limit":1000,"remaining":954,"reset_at":"2025-02-01T00:00:00Z"}},"key":"hard_block_spamtrap","summary":"Hard block - High risk recipient","id":"paths/~1api~1v1~1risk~1preview/post/responses/200/content/application~1json/examples/hard_block_spamtrap"},"paths/~1api~1v1~1risk~1preview/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1risk~1preview/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1risk~1stats/get/responses/200/content/application~1json/example":{"value":{"enabled":true,"quota":{"limit":1000,"used":247,"remaining":753,"reset_at":"2025-02-01T00:00:00Z"},"analytics":{"total_previews":247,"average_risk_score":28.5,"would_block_count":12,"would_block_percentage":4.9,"breakdown":{"recipient":12.3,"content":8.7,"sender":5.2,"behavior":2.3}},"top_factors":[{"reason_code":"disposable_medium_confidence","count":45,"percentage":18.2},{"reason_code":"sender_not_verified","count":38,"percentage":15.4},{"reason_code":"content_risk_medium","count":23,"percentage":9.3},{"reason_code":"free_email_provider","count":18,"percentage":7.3},{"reason_code":"new_account_low_history","count":12,"percentage":4.9}]},"id":"paths/~1api~1v1~1risk~1stats/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1risk~1stats/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1risk~1stats/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1events/get/responses/200/content/application~1json/examples/success":{"value":{"events":[{"id":"550e8400-e29b-41d4-a716-446655440001","email_id":"550e8400-e29b-41d4-a716-446655440000","customer_id":"c0ffee00-beef-4242-cafe-123456789abc","event_type":"opened","status":"success","recipient":"user@example.com","from":"noreply@yourdomain.com","timestamp":"2026-01-26T15:30:00Z","is_scanner":false,"scanner_label":"human","scanner_confidence":15,"is_human_engagement":true,"scanner_detection":{"is_scanner":false,"scanner_label":"human","scanner_confidence":15,"scanner_reason":"Real browser detected: firefox; Human-like delay: 138.8s; Residential IP"},"device_info":{"os":"Windows","browser":"Firefox","device_type":"Desktop","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:133.0) Gecko/20100101 Firefox/133.0","ip_address":"192.168.1.100"},"created_at":"2026-01-26T15:30:00Z"}],"pagination":{"total":1,"page":1,"limit":50,"pages":1}},"key":"success","summary":"Successful response with new convenience fields","id":"paths/~1api~1v1~1events/get/responses/200/content/application~1json/examples/success"},"paths/~1api~1v1~1events/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1events/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1events/get/responses/403/content/application~1json/examples/not_enabled":{"value":{"error":"event_api_disabled","message":"Event tracking API is not enabled for this account."},"key":"not_enabled","summary":"Non-enterprise customer attempting access","id":"paths/~1api~1v1~1events/get/responses/403/content/application~1json/examples/not_enabled"},"paths/~1api~1v1~1events/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1events/get/responses/500/content/application~1json/example"},"paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/200/content/application~1json/examples/success":{"value":{"email_id":"550e8400-e29b-41d4-a716-446655440000","summary":{"total_events":5,"human_engagement_count":2,"scanner_detected_count":0},"events":[{"id":"550e8400-e29b-41d4-a716-446655440001","email_id":"550e8400-e29b-41d4-a716-446655440000","event_type":"sent","status":"success","recipient":"user@example.com","from":"noreply@yourdomain.com","timestamp":"2026-01-26T15:00:00Z","created_at":"2026-01-26T15:00:00Z"},{"id":"550e8400-e29b-41d4-a716-446655440002","email_id":"550e8400-e29b-41d4-a716-446655440000","event_type":"delivered","status":"success","recipient":"user@example.com","from":"noreply@yourdomain.com","timestamp":"2026-01-26T15:02:00Z","created_at":"2026-01-26T15:02:00Z"},{"id":"550e8400-e29b-41d4-a716-446655440003","email_id":"550e8400-e29b-41d4-a716-446655440000","event_type":"opened","status":"success","recipient":"user@example.com","from":"noreply@yourdomain.com","timestamp":"2026-01-26T15:04:18Z","is_scanner":false,"scanner_label":"human","scanner_confidence":15,"is_human_engagement":true,"scanner_detection":{"is_scanner":false,"scanner_label":"human","scanner_confidence":15,"scanner_reason":"Real browser detected: firefox; Human-like delay: 138s; Residential IP"},"device_info":{"os":"Windows","browser":"Firefox","device_type":"Desktop","user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:133.0) Gecko/20100101 Firefox/133.0","ip_address":"192.168.1.100"},"created_at":"2026-01-26T15:04:18Z"}],"timeline":[{"event_type":"sent","timestamp":"2026-01-26T15:00:00Z","status":"success"},{"event_type":"delivered","timestamp":"2026-01-26T15:02:00Z","status":"success"},{"event_type":"opened","timestamp":"2026-01-26T15:04:18Z","status":"success","details":{"is_human_engagement":true}}]},"key":"success","summary":"Email timeline with summary statistics","id":"paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/200/content/application~1json/examples/success"},"paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1v1~1emails~1{email_id}~1events/get/responses/500/content/application~1json/example"},"paths/~1api~1customer~1bounces/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":"550e8400-e29b-41d4-a716-446655440001","recipient":"yasin-bounce-test-23@braincert.com","bounce_type":"hard","smtp_code":"550 5.1.1","reason":"550 5.1.1","diagnostic_code":"Recipient rejected (hard bounce): 550 5.1.1 https://support.google.com/mail/?p=NoSuchUser af79cd13be357-8cbbf6f97dbsi325859585a.212 - gsmtp","domain_id":"7ce691a0-2f45-4dab-8acb-f3b6aa83d944","domain_name":"braincert.com","source":"smtp","created_at":"2026-02-26T01:31:14.000Z"},{"id":"550e8400-e29b-41d4-a716-446655440002","recipient":"full@example.com","bounce_type":"soft","smtp_code":"452 4.2.2","reason":"452 4.2.2 The email account is over quota","diagnostic_code":"Recipient rejected (soft bounce): 452 4.2.2 The email account is over quota. The recipient's mailbox is full.","domain_id":"8af12bc1-3d56-4ebb-9bcd-g4c7bb94e055","domain_name":"example.com","source":"smtp","created_at":"2026-02-26T14:20:03Z"}],"pagination":{"total":4,"limit":100,"offset":0}},"id":"paths/~1api~1customer~1bounces/get/responses/200/content/application~1json/example"},"paths/~1api~1customer~1bounces/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1bounces/get/responses/401/content/application~1json/example"},"paths/~1api~1customer~1bounces/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1customer~1bounces/get/responses/500/content/application~1json/example"},"paths/~1api~1customer~1suppressions/get/responses/200/content/application~1json/example":{"value":{"suppressions":[{"id":"550e8400-e29b-41d4-a716-446655440001","email":"yasin-bounce-test-23@braincert.com","type":"bounce","reason":"Recipient rejected (hard bounce): 550 5.1.1 https://support.google.com/mail/?p=NoSuchUser af79cd13be357-8cbbf6f97dbsi325859585a.212 - gsmtp","source":"smtp","domain_id":"7ce691a0-2f45-4dab-8acb-f3b6aa83d944","domain_name":"braincert.com","created_at":"2026-02-26T01:31:14.000Z"},{"id":"550e8400-e29b-41d4-a716-446655440002","email":"unsub@example.com","type":"unsubscribe","reason":"User requested","source":"api","domain_id":"8af12bc1-3d56-4ebb-9bcd-g4c7bb94e055","domain_name":"example.com","created_at":"2026-02-26T11:00:00Z"}],"counts":{"bounce":15,"complaint":3,"unsubscribe":42},"pagination":{"page":1,"limit":50,"total":60,"pages":2}},"id":"paths/~1api~1customer~1suppressions/get/responses/200/content/application~1json/example"},"paths/~1api~1customer~1suppressions/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1suppressions/get/responses/401/content/application~1json/example"},"paths/~1api~1customer~1suppressions/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1customer~1suppressions/get/responses/500/content/application~1json/example"},"paths/~1api~1customer~1suppressions/post/responses/400/content/application~1json/example":{"value":{"error":"Invalid domain name"},"id":"paths/~1api~1customer~1suppressions/post/responses/400/content/application~1json/example"},"paths/~1api~1customer~1suppressions/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1suppressions/post/responses/401/content/application~1json/example"},"paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/401/content/application~1json/example"},"paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1customer~1suppressions~1{suppressionId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1customer~1unsubscribes/get/responses/200/content/application~1json/example":{"value":{"unsubscribes":[{"id":"unsub_123","email":"user@example.com","source":"one-click","reason":"One-click unsubscribe","created_at":"2025-12-08T12:00:00Z"},{"id":"unsub_124","email":"another@example.com","source":"link","reason":"User clicked unsubscribe link","created_at":"2025-12-07T15:30:00Z"}],"pagination":{"page":1,"limit":50,"total":25,"pages":1}},"id":"paths/~1api~1customer~1unsubscribes/get/responses/200/content/application~1json/example"},"paths/~1api~1customer~1unsubscribes/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1unsubscribes/get/responses/401/content/application~1json/example"},"paths/~1api~1customer~1unsubscribes/get/responses/500/content/application~1json/example":{"value":{"error":"An unexpected error occurred"},"id":"paths/~1api~1customer~1unsubscribes/get/responses/500/content/application~1json/example"},"paths/~1api~1customer~1unsubscribes/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1unsubscribes/post/responses/401/content/application~1json/example"},"paths/~1api~1customer~1unsubscribes~1import/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1unsubscribes~1import/post/responses/401/content/application~1json/example"},"paths/~1api~1customer~1unsubscribes~1{email}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1unsubscribes~1{email}/delete/responses/401/content/application~1json/example"},"paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/global":{"value":{"scope":"global","health_score":{"overall_score":92,"delivery_rate":98.5,"open_rate":24.3,"click_rate":3.8,"bounce_rate":1.5,"complaint_rate":0.08,"reputation_grade":"Excellent","last_calculated":"2026-01-11T15:00:00Z"},"insights":[{"type":"success","message":"Excellent email health! Your sending practices are top-notch."}],"benchmarks":{"delivery_rate":{"good":98,"average":95,"poor":90},"open_rate":{"good":20,"average":15,"poor":10}}},"key":"global","summary":"global","id":"paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/global"},"paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/domain_specific":{"value":{"scope":"domain","domain":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"mail.example.com"},"health_score":{"overall_score":88,"delivery_rate":97.2,"open_rate":22.1,"click_rate":3.2,"bounce_rate":2.8,"complaint_rate":0.12,"reputation_grade":"Good","last_calculated":"2026-01-11T15:00:00Z"},"insights":[{"type":"info","message":"Good email health for this domain."}],"benchmarks":{"delivery_rate":{"good":98,"average":95,"poor":90},"open_rate":{"good":20,"average":15,"poor":10}}},"key":"domain_specific","summary":"domain_specific","id":"paths/~1api~1customer~1health-score/get/responses/200/content/application~1json/examples/domain_specific"},"paths/~1api~1customer~1health-score/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1health-score/get/responses/401/content/application~1json/example"},"paths/~1api~1customer~1health-score~1history/get/responses/200/content/application~1json/example":{"value":{"history":[{"date":"2025-12-08","overall_score":92,"delivery_rate":98.5,"open_rate":24.3,"click_rate":3.8,"bounce_rate":1.5,"complaint_rate":0.08},{"date":"2025-12-07","overall_score":91,"delivery_rate":98.2,"open_rate":23.8,"click_rate":3.5,"bounce_rate":1.8,"complaint_rate":0.09}],"period_days":30},"id":"paths/~1api~1customer~1health-score~1history/get/responses/200/content/application~1json/example"},"paths/~1api~1customer~1health-score~1history/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1health-score~1history/get/responses/401/content/application~1json/example"},"paths/~1api~1customer~1health-score~1refresh/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1customer~1health-score~1refresh/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1webhooks/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks/post/responses/201/content/application~1json/example":{"value":{"webhook":{"id":"550e8400-e29b-41d4-a716-446655440010","customer_id":"550e8400-e29b-41d4-a716-446655440000","name":"Production Webhook","url":"https://api.example.com/webhooks/email-events","description":"Main production webhook","domain_ids":["550e8400-e29b-41d4-a716-446655440001"],"domains":[{"id":"550e8400-e29b-41d4-a716-446655440001","domain":"mail.example.com"}],"events":["email.delivered","email.bounced"],"is_active":true,"secret":"8f2b5d8c8f4544e4b11682a4d7e0f681ab12cd34ef56ab78cd90ef12ab34cd56","signing_secret":"8f2b5d8c8f4544e4b11682a4d7e0f681ab12cd34ef56ab78cd90ef12ab34cd56","last_triggered_at":null,"last_status":null,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T10:30:00Z"},"message":"Webhook created successfully"},"id":"paths/~1api~1v1~1customer~1webhooks/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks/post/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1customer~1webhooks/post/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1webhooks/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/put/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1test/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/200/content/application~1json/example":{"value":{"webhook":{"id":"550e8400-e29b-41d4-a716-446655440010","customer_id":"550e8400-e29b-41d4-a716-446655440000","name":"Production Webhook","url":"https://api.example.com/webhooks/email-events","description":"Main production webhook","domain_ids":["550e8400-e29b-41d4-a716-446655440001"],"domains":[{"id":"550e8400-e29b-41d4-a716-446655440001","domain":"mail.example.com"}],"events":["email.delivered","email.bounced"],"is_active":true,"secret":"91c3f46ea1044c42b29da4238a8d7237e62f67a08cc8116ae4bf02b7f672a10e","signing_secret":"91c3f46ea1044c42b29da4238a8d7237e62f67a08cc8116ae4bf02b7f672a10e","last_triggered_at":"2024-01-20T14:30:00Z","last_status":200,"created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-22T09:15:00Z"},"message":"Webhook secret regenerated successfully"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1customer~1webhooks~1{webhookId}~1regenerate-secret/post/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts/get/responses/200/content/application~1json/examples/with_engagement":{"value":{"success":true,"data":[{"id":"c608a108-fa66-49c9-8ac0-560a80be9b62","email":"john@example.com","first_name":"John","last_name":"Doe","status":"subscribed","total_sent":8,"total_opened":3,"total_clicked":2,"last_sent_at":"2026-02-12T10:30:00Z","engagement_score":78,"engagement_label":"Highly Engaged","engagement_color":"green","engagement_breakdown":{"open_rate":38,"click_rate":25,"total_sent":8,"total_opened":3,"total_clicked":2,"days_since_last_send":6},"tags":["premium","newsletter"],"created_at":"2026-02-05T21:44:43.845Z","updated_at":"2026-02-12T10:30:00Z"},{"id":"a2b3c4d5-e6f7-8901-2345-678901234567","email":"jane@example.com","first_name":"Jane","last_name":"Smith","status":"subscribed","total_sent":3,"total_opened":0,"total_clicked":0,"last_sent_at":"2026-02-10T14:20:00Z","engagement_score":24,"engagement_label":"Cold","engagement_color":"orange","engagement_breakdown":{"open_rate":0,"click_rate":0,"total_sent":3,"total_opened":0,"total_clicked":0,"days_since_last_send":8},"tags":[],"created_at":"2026-02-10T12:15:00Z","updated_at":"2026-02-10T14:20:00Z"}],"pagination":{"page":1,"limit":100,"total":239,"total_pages":3}},"key":"with_engagement","summary":"Contacts with engagement scores","id":"paths/~1api~1v1~1contacts/get/responses/200/content/application~1json/examples/with_engagement"},"paths/~1api~1v1~1contacts/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/basic":{"value":{"email":"john@example.com","first_name":"John","last_name":"Doe"},"key":"basic","summary":"Basic contact","id":"paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/basic"},"paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/full":{"value":{"email":"jane@example.com","first_name":"Jane","last_name":"Doe","phone":"+1234567890","city":"San Francisco","country":"USA","status":"subscribed","tags":["vip","newsletter"],"custom_properties":{"company":"BrainCert","role":"CEO","annual_revenue":"5000000"}},"key":"full","summary":"Contact with all fields","id":"paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/full"},"paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/double_opt_in":{"value":{"email":"subscriber@example.com","double_opt_in":true,"source":"newsletter","tags":["newsletter"],"consent":{"ip":"203.0.113.8","user_agent":"Mozilla/5.0","source_url":"https://example.com/newsletter","timestamp":"2026-07-06T14:20:15Z","consent_text":"I agree to receive newsletters."},"confirmation":{"from_email":"newsletter@example.com","from_name":"Example Brand","redirect_url":"https://example.com/confirmed"}},"key":"double_opt_in","summary":"Contact with double opt-in confirmation","id":"paths/~1api~1v1~1contacts/post/requestBody/content/application~1json/examples/double_opt_in"},"paths/~1api~1v1~1contacts/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}~1send-confirmation/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/basic_import":{"value":{"contacts":[{"email":"jane@example.com","first_name":"Jane","last_name":"Doe"},{"email":"john@example.com","first_name":"John","last_name":"Smith"}],"on_conflict":"skip"},"key":"basic_import","summary":"Basic import with required fields","id":"paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/basic_import"},"paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/full_import":{"value":{"contacts":[{"email":"jane@example.com","first_name":"Jane","last_name":"Doe","phone":"+1234567890","city":"San Francisco","country":"USA","status":"subscribed","tags":["newsletter","vip","premium"],"custom_properties":{"company":"BrainCert","role":"CEO","annual_revenue":"5000000","signup_date":"2026-01-15"}},{"email":"john@example.com","first_name":"John","last_name":"Smith","tags":["newsletter"],"custom_properties":{"company":"Acme Inc","role":"Manager"}}],"on_conflict":"update"},"key":"full_import","summary":"Import with all fields and custom properties","id":"paths/~1api~1v1~1contacts~1import/post/requestBody/content/application~1json/examples/full_import"},"paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/all_success":{"value":{"success":true,"data":{"created":100,"updated":0,"skipped":0,"errors":[]}},"key":"all_success","summary":"All contacts imported successfully","id":"paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/all_success"},"paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/partial_success":{"value":{"success":true,"data":{"created":98,"updated":0,"skipped":2,"errors":[{"email":"invalid@","error":"Invalid email format"},{"email":"missing","error":"Email is required"}]}},"key":"partial_success","summary":"Some contacts failed validation","id":"paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/partial_success"},"paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/update_mode":{"value":{"success":true,"data":{"created":50,"updated":10,"skipped":0,"errors":[]}},"key":"update_mode","summary":"Import with updates","id":"paths/~1api~1v1~1contacts~1import/post/responses/200/content/application~1json/examples/update_mode"},"paths/~1api~1v1~1contacts~1import/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1import/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1lookup/get/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1contacts~1lookup/get/responses/400/content/application~1json/example"},"paths/~1api~1v1~1contacts~1lookup/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1lookup/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1lookup/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1lookup/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1by-email~1{email}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":"c608a108-fa66-49c9-8ac0-560a80be9b62","email":"john@example.com","first_name":"John","last_name":"Doe","status":"subscribed","total_sent":8,"total_opened":3,"total_clicked":2,"last_sent_at":"2026-02-12T10:30:00Z","engagement_score":78,"engagement_label":"Highly Engaged","engagement_color":"green","engagement_breakdown":{"open_rate":38,"click_rate":25,"total_sent":8,"total_opened":3,"total_clicked":2,"days_since_last_send":6},"tags":["premium","newsletter"],"segments":["Active Users","Newsletter Subscribers"],"created_at":"2026-02-05T21:44:43.845Z","updated_at":"2026-02-12T10:30:00Z"}},"id":"paths/~1api~1v1~1contacts~1{id}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":"123e4567-e89b-12d3-a456-426614174000","subject":"Welcome to our platform","status":"delivered","from_email":"hello@example.com","to_email":"contact@example.com","sent_at":"2026-02-11T10:30:00Z","delivered_at":"2026-02-11T10:30:15Z","opened_at":"2026-02-11T11:45:00Z","clicked_at":"2026-02-11T11:46:30Z","open_count":3,"click_count":2,"bounce_type":null,"bounce_reason":null,"events":[{"event_type":"sent","created_at":"2026-02-11T10:30:00Z"},{"event_type":"delivered","created_at":"2026-02-11T10:30:15Z"},{"event_type":"opened","created_at":"2026-02-11T11:45:00Z","ip_address":"203.0.113.42","user_agent":"Mozilla/5.0..."}]}],"pagination":{"page":1,"limit":50,"total":156,"pages":4}},"id":"paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}~1emails/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_filter_builder":{"value":{"name":"Engaged Newsletter Subscribers","description":"Subscribed contacts who opened our welcome campaign","is_dynamic":true,"filter_conditions":{"filters":[{"field":"status","operator":"equals","value":"subscribed"},{"field":"campaign_opened","operator":"has_opened","value":"aa53af3b-a5ea-4057-9618-88c5245b842a"},{"field":"tags","operator":"in","value":["newsletter","verified"]}],"match_type":"all"}},"key":"dynamic_segment_filter_builder","summary":"Dynamic segment with filter builder (recommended)","id":"paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_filter_builder"},"paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_custom_properties":{"value":{"name":"Enterprise Customers","description":"Companies with 100+ employees","is_dynamic":true,"filter_conditions":{"filters":[{"field":"status","operator":"equals","value":"subscribed"},{"field":"custom_properties.company_size","operator":">=","value":100},{"field":"custom_properties.industry","operator":"equals","value":"Technology"}],"match_type":"all"}},"key":"dynamic_segment_custom_properties","summary":"Dynamic segment with custom properties","id":"paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/dynamic_segment_custom_properties"},"paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/static_segment":{"value":{"name":"Product Launch List","description":"Hand-picked contacts for product launch","is_dynamic":false,"contact_ids":["550e8400-e29b-41d4-a716-446655440001","550e8400-e29b-41d4-a716-446655440002"]},"key":"static_segment","summary":"Static segment example","id":"paths/~1api~1v1~1contacts~1segments/post/requestBody/content/application~1json/examples/static_segment"},"paths/~1api~1v1~1contacts~1segments/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}~1refresh/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1preview/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1preview/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1segments~1{id}~1contacts/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1tags/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1tags/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/fixTypo":{"value":{"new_name":"newsletter"},"key":"fixTypo","summary":"Fix a typo","id":"paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/fixTypo"},"paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/changeCase":{"value":{"new_name":"premium"},"key":"changeCase","summary":"Change case","id":"paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/requestBody/content/application~1json/examples/changeCase"},"paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1tags~1{tagName}/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/consolidateCaseVariations":{"value":{"source_tags":["Newsletter","newsletter","NEWSLETTER"],"target_tag":"newsletter"},"key":"consolidateCaseVariations","summary":"Consolidate case variations","id":"paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/consolidateCaseVariations"},"paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/mergeVIPTags":{"value":{"source_tags":["vip","VIP Customer","vip-member"],"target_tag":"VIP"},"key":"mergeVIPTags","summary":"Merge VIP variations","id":"paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/mergeVIPTags"},"paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/cleanupYearlyTags":{"value":{"source_tags":["customer-2024","customer-2025"],"target_tag":"customer"},"key":"cleanupYearlyTags","summary":"Cleanup yearly customer tags","id":"paths/~1api~1v1~1contacts~1tags~1merge/post/requestBody/content/application~1json/examples/cleanupYearlyTags"},"paths/~1api~1v1~1contacts~1tags~1merge/post/responses/200/content/application~1json/examples/success":{"value":{"success":true,"data":{"source_tags":["Newsletter","newsletter","NEWSLETTER"],"target_tag":"newsletter","contacts_affected":150,"tags_removed":298,"tags_added":23}},"key":"success","summary":"success","id":"paths/~1api~1v1~1contacts~1tags~1merge/post/responses/200/content/application~1json/examples/success"},"paths/~1api~1v1~1contacts~1tags~1merge/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1tags~1merge/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1tags/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}~1tags/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}~1tags/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}~1tags~1{tagName}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-groups/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-groups/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1property-groups~1{id}/put/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1property-groups~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/400/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1property-groups~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-definitions/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-definitions/post/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/get/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/400/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/put/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/400/content/application~1json/example":{"value":{"error":"Invalid webhook URL or event types"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/400/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/patch/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/404/content/application~1json/example":{"value":{"error":"Domain not found"},"id":"paths/~1api~1v1~1contacts~1property-definitions~1{id}/delete/responses/404/content/application~1json/example"},"paths/~1api~1v1~1contacts~1custom-properties~1keys/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1custom-properties~1keys/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}~1custom-properties/get/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1{id}~1custom-properties/put/responses/401/content/application~1json/example"},"paths/~1api~1v1~1contacts~1search-by-property/post/responses/401/content/application~1json/example":{"value":{"error":"Invalid API key"},"id":"paths/~1api~1v1~1contacts~1search-by-property/post/responses/401/content/application~1json/example"}},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key authentication (PRIMARY method for most endpoints)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer portal endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMTP credentials ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/smtp-credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statistics endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/stats/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain management ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/domains"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health scores, unsubscribes, rate limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-API-Key: ml_live_1234567890abcdef...\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get your API key from your customer dashboard or use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/customer/rotate-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"in":"header","paramName":"X-API-Key"},"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"API Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer API Key using Bearer token authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this ONLY for Events Tracking API:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/events"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v1/emails/{email_id}/events"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer ml_live_1234567890abcdef...\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer ml_live_1234567890abcdef...\n"},"children":[]}]}]}},"servers":[{"url":"https://api.mailerlogic.net","description":"US Data Center"},{"url":"https://eu-api.mailerlogic.net","description":"EU Data Center (coming soon)"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/customer-api.openapi","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/customer-api.openapi.json?download"},{"url":"/_bundle/customer-api.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"MailerLogic API","description":"Complete REST API for managing email delivery, tracking, and analytics.\n\nGet started in minutes:\n1. Get your API key from your customer dashboard\n2. Send authenticated requests using the X-API-Key header\n3. Start sending emails via SMTP or API\n\nFor detailed guides, see the Getting Started section in the navigation.\n\n## Response Conventions\n\nNew and updated endpoints use these shapes:\n\n- List endpoints: `{ \"data\": [ ... ], \"pagination\": { ... } }`\n- Single-resource endpoints: `{ \"data\": { ... } }`\n- Errors: `{ \"error\": \"Human-readable message\", \"code\": \"ERROR_CODE\", \"details\": {}, \"request_id\": \"...\" }`\n\nSome older endpoints also return legacy fields such as `webhook`, `webhooks`, or `success` for backward compatibility. Prefer `data` in new integrations when both are present.\n\nEvery API response includes an `X-Request-ID` header. Include this value when contacting support.\n"}},"baseSlug":"/customer-api.openapi","routesMapping":{}}