--- agentTools: projectIndex: https://mailivery.readme.io/llms.txt --- # Fetch Active Sending Schedule Retrieve the sending schedule currently in effect for a mailbox (campaign) — the configured timezone plus the day-and-hour window during which warm-up emails are sent (e.g. weekdays 8 AM – 6 PM in `America/Chicago`). Use this to render the active schedule in your UI before letting users edit it via *Update Sending Schedule*. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Mailivery API", "description": "Welcome to the Mailivery API – the programmatic way to connect mailboxes, automate warm-up, and monitor deliverability from inside your own product or scripts.\n\n> **Terminology note — mailbox vs. campaign.** In the Mailivery dashboard, a connected sending account is called a **mailbox**. In the API, the same entity is modeled as a **campaign** — that's why request paths use `/campaigns/...`, identifiers are named `campaignId` / `campaign_id`, and the response schema is `Campaign`. Throughout this reference, when an endpoint description says \"mailbox,\" it refers to the same underlying record as `campaignId` in the URL or payload. No data difference — just two names for one thing.\n\n## Getting Started\n\nTo start integrating Mailivery into your application, follow these steps:\n\n### 1\\. **Sign Up for API Access**\n\nConnect with Our Product team and get Your API Keys.\n\n### 2\\. **API Documentation**\n\nRefer to our comprehensive API documentation for detailed information on endpoints, request and response formats, and authentication mechanisms. The documentation provides clear guidance on implementing Mailivery's API in your application.\n\n### 3\\. **Explore Code Samples**\n\nAccelerate your integration process by exploring our collection of code samples. These samples cover common use cases and showcase best practices for integrating Mailivery's API seamlessly.\n\n### 4\\. **Support and Resources**\n\nIf you encounter any challenges or have questions during the integration process, our dedicated support team is here to assist you.\n\n## Conclusion\n\nUnlock the full potential of Mailivery's email warm-up tool with our API. By seamlessly integrating our solution into your applications, you improve email deliverability and establish a robust sender reputation that stands the test of SPAM algorithms. Get started today and elevate your email marketing success with Mailivery.", "version": "1.1.0", "contact": { "name": "Suraj Jadhav", "email": "suraj@sourceitmarketing.com", "url": "https://mailivery.io" }, "termsOfService": "https://mailivery.io", "license": { "name": "Custom License", "url": "https://mailivery.io" } }, "servers": [ { "url": "https://app.mailivery.io/api/v1", "description": "Production / Live server" }, { "url": "https://app-staging.mailivery.io/api/v1", "description": "Staging / Testing server" } ], "paths": { "/campaigns/{campaignId}/fetch-active-schedule": { "patch": { "tags": [ "Warm-Up Controls" ], "summary": "Fetch Active Sending Schedule", "description": "Retrieve the sending schedule currently in effect for a mailbox (campaign) — the configured timezone plus the day-and-hour window during which warm-up emails are sent (e.g. weekdays 8 AM – 6 PM in `America/Chicago`). Use this to render the active schedule in your UI before letting users edit it via *Update Sending Schedule*.", "operationId": "fetchActiveSendingSchedule", "requestBody": { "content": {} }, "responses": { "200": { "description": "STATUS 200", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-cache, private" } }, "Connection": { "schema": { "type": "string", "example": "Keep-Alive" } }, "Date": { "schema": { "type": "string", "example": "Thu, 11 Jan 2024 00:42:34 GMT" } }, "Keep-Alive": { "schema": { "type": "string", "example": "timeout=5, max=100" } }, "Server": { "schema": { "type": "string", "example": "Apache/2.4.54 (Win64) OpenSSL/1.1.1q PHP/8.1.10" } }, "Transfer-Encoding": { "schema": { "type": "string", "example": "chunked" } }, "Vary": { "schema": { "type": "string", "example": "Authorization" } }, "X-Powered-By": { "schema": { "type": "string", "example": "PHP/8.1.10" } }, "X-RateLimit-Limit": { "schema": { "type": "string", "example": "60" } }, "X-RateLimit-Remaining": { "schema": { "type": "string", "example": "58" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ], "x-stoplight": { "id": "fwd3qhw8xkrz2" }, "parameters": [ { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ] }, "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "integer", "example": 83 }, "description": "Campaign ID." }, { "name": "X-Request-ID", "in": "header", "required": true, "schema": { "type": "string", "example": "43873599-9e19-42e6-9a5b-b2bc0a264a28" }, "description": "Any unique string, timestamp, or UUID for logging." }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "type": "string", "default": "multipart/form-data", "example": "application/x-www-form-urlencoded" }, "description": "Request Content-Type" }, { "name": "Accept", "in": "header", "required": true, "schema": { "type": "string", "default": "application/json", "example": "application/json" }, "description": "Expected Type for response" } ] } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "parameters": { "X-Request-ID": { "name": "X-Request-ID", "in": "header", "required": true, "schema": { "type": "string", "example": "43873599-9e19-42e6-9a5b-b2bc0a264a28" }, "description": "Any unique string, timestamp, or UUID for logging." }, "Content-Type": { "name": "Content-Type", "in": "header", "required": true, "schema": { "type": "string", "default": "multipart/form-data", "example": "application/x-www-form-urlencoded" }, "description": "Request Content-Type" }, "Accept": { "name": "Accept", "in": "header", "required": true, "schema": { "type": "string", "default": "application/json", "example": "application/json" }, "description": "Expected Type for response" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Warm-Up Controls", "description": "This collection of requests represents every action that can be performed on a single campaign." } ], "x-tagGroups": [ { "name": "Getting Started", "tags": [ "Mailivery API Introduction" ] }, { "name": "Connecting Mailboxes", "tags": [ "Connecting Mailboxes" ] }, { "name": "Warm-Up Controls", "tags": [ "Warm-Up Controls" ] }, { "name": "Managing Mailboxes", "tags": [ "Managing Mailboxes" ] }, { "name": "Metrics & Health", "tags": [ "Metrics & Health" ] }, { "name": "Custom Warm-Up Templates", "tags": [ "Custom Warm-Up Templates" ] }, { "name": "Yahoo Deliverability Filter", "tags": [ "Yahoo Deliverability Filter" ] }, { "name": "Warm-Up Audience", "tags": [ "Warm-Up Audience" ] }, { "name": "Object Structures", "tags": [ "Object Structures" ] }, { "name": "Webhooks", "tags": [ "Webhooks" ] }, { "name": "Connection Recheck", "tags": [ "Connection Health" ] }, { "name": "Inbox Placement Test (Beta)", "tags": [ "IPT - Tests", "IPT - Results", "IPT - Schedule", "IPT - Resources" ] }, { "name": "Blacklist Monitoring", "tags": [ "Blacklist Monitoring" ] }, { "name": "Email Verification", "tags": [ "Email Verification" ] } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 106, "1": 188, "2": 56, "3": 116, "4": 238, "5": 154, "6": 138, "7": 7, "8": 188, "9": 72, "10": 137, "11": 106 } } } ```