{"items":[{"type":"link","label":"MailerLogic API","link":"/customer-api.openapi","routeSlug":"/customer-api.openapi"},{"type":"link","label":"Response Conventions","link":"/customer-api.openapi/section/response-conventions","routeSlug":"/customer-api.openapi/section/response-conventions"},{"type":"separator","label":"Getting Started"},{"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"},{"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"},{"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"},{"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"},{"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)"},{"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"},{"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"},{"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"},{"type":"link","label":"Next Steps","link":"/customer-api.openapi/quickstart-guide/next-steps","routeSlug":"/customer-api.openapi/quickstart-guide/next-steps"},{"type":"link","label":"Common Issues","link":"/customer-api.openapi/quickstart-guide/common-issues","routeSlug":"/customer-api.openapi/quickstart-guide/common-issues"}]},{"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"},{"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"},{"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"},{"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"},{"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"},{"type":"link","label":"🖥️ IP Pool Management","link":"/customer-api.openapi/features-overview/ip-pool-management","routeSlug":"/customer-api.openapi/features-overview/ip-pool-management"},{"type":"link","label":"🔔 Webhooks & Integration","link":"/customer-api.openapi/features-overview/webhooks-and-integration","routeSlug":"/customer-api.openapi/features-overview/webhooks-and-integration"},{"type":"link","label":"🔐 Security & Compliance","link":"/customer-api.openapi/features-overview/security-and-compliance","routeSlug":"/customer-api.openapi/features-overview/security-and-compliance"},{"type":"link","label":"🛠️ Developer Tools","link":"/customer-api.openapi/features-overview/developer-tools","routeSlug":"/customer-api.openapi/features-overview/developer-tools"},{"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"},{"type":"link","label":"💼 Use Cases","link":"/customer-api.openapi/features-overview/use-cases","routeSlug":"/customer-api.openapi/features-overview/use-cases"}]},{"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"},{"type":"link","label":"📊 Responsibility Matrix","link":"/customer-api.openapi/shared-responsibility-model/responsibility-matrix","routeSlug":"/customer-api.openapi/shared-responsibility-model/responsibility-matrix"},{"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"},{"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"},{"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"},{"type":"link","label":"💡 Best Practices","link":"/customer-api.openapi/shared-responsibility-model/best-practices","routeSlug":"/customer-api.openapi/shared-responsibility-model/best-practices"},{"type":"link","label":"📞 Need Help?","link":"/customer-api.openapi/shared-responsibility-model/need-help","routeSlug":"/customer-api.openapi/shared-responsibility-model/need-help"}]},{"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"},{"type":"link","label":"💳 Account & Billing","link":"/customer-api.openapi/faq/account-and-billing","routeSlug":"/customer-api.openapi/faq/account-and-billing"},{"type":"link","label":"🌐 Domain Setup & Verification","link":"/customer-api.openapi/faq/domain-setup-and-verification","routeSlug":"/customer-api.openapi/faq/domain-setup-and-verification"},{"type":"link","label":"✉️ Sending Emails","link":"/customer-api.openapi/faq/sending-emails","routeSlug":"/customer-api.openapi/faq/sending-emails"},{"type":"link","label":"📊 Tracking & Analytics","link":"/customer-api.openapi/faq/tracking-and-analytics","routeSlug":"/customer-api.openapi/faq/tracking-and-analytics"},{"type":"link","label":"📬 Deliverability","link":"/customer-api.openapi/faq/deliverability","routeSlug":"/customer-api.openapi/faq/deliverability"},{"type":"link","label":"🔐 Security & Compliance","link":"/customer-api.openapi/faq/security-and-compliance","routeSlug":"/customer-api.openapi/faq/security-and-compliance"},{"type":"link","label":"🔧 Technical Questions","link":"/customer-api.openapi/faq/technical-questions","routeSlug":"/customer-api.openapi/faq/technical-questions"},{"type":"link","label":"🛠️ Troubleshooting","link":"/customer-api.openapi/faq/troubleshooting","routeSlug":"/customer-api.openapi/faq/troubleshooting"},{"type":"link","label":"👥 CRM & Contact Management","link":"/customer-api.openapi/faq/crm-and-contact-management","routeSlug":"/customer-api.openapi/faq/crm-and-contact-management"},{"type":"link","label":"💬 Support","link":"/customer-api.openapi/faq/support","routeSlug":"/customer-api.openapi/faq/support"}]},{"type":"separator","label":"Email Infrastructure API"},{"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"},{"type":"link","label":"Available Stream Types","link":"/customer-api.openapi/email-sending/available-stream-types","routeSlug":"/customer-api.openapi/email-sending/available-stream-types"},{"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"},{"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"},{"type":"link","label":"Best Practices","link":"/customer-api.openapi/email-sending/best-practices","routeSlug":"/customer-api.openapi/email-sending/best-practices"},{"type":"link","label":"Email Lifecycle Events","link":"/customer-api.openapi/email-sending/email-lifecycle-events","routeSlug":"/customer-api.openapi/email-sending/email-lifecycle-events"},{"type":"link","label":"Important","link":"/customer-api.openapi/email-sending/important","routeSlug":"/customer-api.openapi/email-sending/important"},{"type":"link","label":"Standard Send Response","link":"/customer-api.openapi/email-sending/standard-send-response","routeSlug":"/customer-api.openapi/email-sending/standard-send-response"},{"type":"link","label":"Tracked Events","link":"/customer-api.openapi/email-sending/tracked-events","routeSlug":"/customer-api.openapi/email-sending/tracked-events"},{"type":"link","label":"Automatic Retry Policy","link":"/customer-api.openapi/email-sending/automatic-retry-policy","routeSlug":"/customer-api.openapi/email-sending/automatic-retry-policy"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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:"}},"httpPath":"/api/v1/test-deliverability"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/campaigns/{campaignId}/links"}]},{"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:"}},"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."}},"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."}},"httpPath":"/api/v1/customer/rotate-key"}]},{"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"},{"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"},{"type":"link","label":"Example: PHPMailer","link":"/customer-api.openapi/smtp/example:-phpmailer","routeSlug":"/customer-api.openapi/smtp/example:-phpmailer"},{"type":"link","label":"Example: Nodemailer","link":"/customer-api.openapi/smtp/example:-nodemailer","routeSlug":"/customer-api.openapi/smtp/example:-nodemailer"},{"type":"link","label":"Example: Python (smtplib)","link":"/customer-api.openapi/smtp/example:-python-(smtplib)","routeSlug":"/customer-api.openapi/smtp/example:-python-(smtplib)"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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"}},"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."}},"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."}},"httpPath":"/api/v1/smtp-credentials/rotate"}]},{"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."}},"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."}},"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)."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/customer/domains/{id}/tracking-domain"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/customer/tracking-domains/{id}/ssl"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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)."}},"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.)."}},"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)."}},"httpPath":"/api/v1/stats/outbound/clicks"}]},{"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."}},"httpPath":"/api/v1/content-score"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/address/validate/quota"}]},{"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."}},"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."}},"httpPath":"/api/v1/risk/stats"}]},{"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"},{"type":"link","label":"Data Retention","link":"/customer-api.openapi/events/data-retention","routeSlug":"/customer-api.openapi/events/data-retention"},{"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."}},"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."}},"httpPath":"/api/v1/emails/{email_id}/events"}]},{"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."}},"httpPath":"/api/customer/bounces"}]},{"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."}},"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."}},"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."}},"httpPath":"/api/customer/suppressions/{suppressionId}"}]},{"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/customer/unsubscribes/{email}"}]},{"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."}},"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."}},"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."}},"httpPath":"/api/customer/health-score/refresh"}]},{"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."}},"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."}},"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."}},"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."}},"httpPath":"/track/u/{token}"}]},{"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"},{"type":"link","label":"contact.tag_added","link":"/customer-api.openapi/outbound-webhooks/contact.tag_added","routeSlug":"/customer-api.openapi/outbound-webhooks/contact.tag_added"},{"type":"link","label":"contact.tag_removed","link":"/customer-api.openapi/outbound-webhooks/contact.tag_removed","routeSlug":"/customer-api.openapi/outbound-webhooks/contact.tag_removed"},{"type":"link","label":"email.delivered","link":"/customer-api.openapi/outbound-webhooks/email.delivered","routeSlug":"/customer-api.openapi/outbound-webhooks/email.delivered"},{"type":"link","label":"email.opened","link":"/customer-api.openapi/outbound-webhooks/email.opened","routeSlug":"/customer-api.openapi/outbound-webhooks/email.opened"},{"type":"link","label":"email.clicked","link":"/customer-api.openapi/outbound-webhooks/email.clicked","routeSlug":"/customer-api.openapi/outbound-webhooks/email.clicked"},{"type":"link","label":"email.bounced","link":"/customer-api.openapi/outbound-webhooks/email.bounced","routeSlug":"/customer-api.openapi/outbound-webhooks/email.bounced"},{"type":"link","label":"email.complained","link":"/customer-api.openapi/outbound-webhooks/email.complained","routeSlug":"/customer-api.openapi/outbound-webhooks/email.complained"},{"type":"link","label":"email.unsubscribed","link":"/customer-api.openapi/outbound-webhooks/email.unsubscribed","routeSlug":"/customer-api.openapi/outbound-webhooks/email.unsubscribed"},{"type":"link","label":"email.failed","link":"/customer-api.openapi/outbound-webhooks/email.failed","routeSlug":"/customer-api.openapi/outbound-webhooks/email.failed"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/customer/webhooks/{webhookId}/regenerate-secret"}]},{"type":"separator","label":"CRM & Contacts"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/contacts/{id}/emails"}]},{"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."}},"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)."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/contacts/segments/{id}/contacts"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/contacts/{id}/tags/{tagName}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/api/v1/contacts/search-by-property"}]}]}