{"openapi":"3.1.0","info":{"title":"MailChannels (BYOK) API","version":"0.1.0","description":"MailChannels (BYOK) lets an AI assistant read your own MailChannels data through the MailChannels API with a key you supply (MailChannels API key). Read-only: 11 tools (get_usage, get_volume_metrics, get_performance_metrics, get_engagement_metrics, get_recipient_behaviour_metrics, get_sender_metrics, list_suppressions, list_sub_accounts, list_dkim_keys, list_tracking_domains, list_webhooks). The...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-mailchannels.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-mailchannels/docs"},"termsOfService":"https://connectorbay.com/byok-mailchannels/terms"},"servers":[{"url":"https://byok-mailchannels.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-mailchannels/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_usage":{"post":{"operationId":"get_usage","summary":"Show email usage in the current billing period: total sends, monthly limit and period start and end. Use for \"How many e","description":"Show email usage in the current billing period: total sends, monthly limit and period start and end. Use for \"How many emails have I sent this billing period with MailChannels\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_usageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_volume_metrics":{"post":{"operationId":"get_volume_metrics","summary":"Get message volume totals for a time range: processed, delivered and dropped counts. Use for \"How many emails did MailCh","description":"Get message volume totals for a time range: processed, delivered and dropped counts. Use for \"How many emails did MailChannels deliver last week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the range (inclusive), as YYYY-MM-DD or an ISO 8601 date-time. Defaults to the API's own default window when omitted.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the range (exclusive), as YYYY-MM-DD or an ISO 8601 date-time.","title":"End Time"},"campaign_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages of this campaign ID; all campaigns when omitted.","title":"Campaign Id"},"interval":{"anyOf":[{"enum":["hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Aggregation interval for the buckets.","title":"Interval"}},"title":"get_volume_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_performance_metrics":{"post":{"operationId":"get_performance_metrics","summary":"Get delivery performance totals for a time range: processed, delivered, bounced and complained counts. Use for \"What was","description":"Get delivery performance totals for a time range: processed, delivered, bounced and complained counts. Use for \"What was my MailChannels bounce and complaint count this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the range (inclusive), as YYYY-MM-DD or an ISO 8601 date-time. Defaults to the API's own default window when omitted.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the range (exclusive), as YYYY-MM-DD or an ISO 8601 date-time.","title":"End Time"},"campaign_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages of this campaign ID; all campaigns when omitted.","title":"Campaign Id"},"interval":{"anyOf":[{"enum":["hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Aggregation interval for the buckets.","title":"Interval"}},"title":"get_performance_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_engagement_metrics":{"post":{"operationId":"get_engagement_metrics","summary":"Get opens and clicks (total and unique) with the counts of messages delivered with tracking, for a time range. Use for \"","description":"Get opens and clicks (total and unique) with the counts of messages delivered with tracking, for a time range. Use for \"How many opens and clicks did my MailChannels emails get\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the range (inclusive), as YYYY-MM-DD or an ISO 8601 date-time. Defaults to the API's own default window when omitted.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the range (exclusive), as YYYY-MM-DD or an ISO 8601 date-time.","title":"End Time"},"campaign_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages of this campaign ID; all campaigns when omitted.","title":"Campaign Id"},"interval":{"anyOf":[{"enum":["hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Aggregation interval for the buckets.","title":"Interval"}},"title":"get_engagement_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_recipient_behaviour_metrics":{"post":{"operationId":"get_recipient_behaviour_metrics","summary":"Get unsubscribe counts and unsubscribe-link deliveries for a time range. Use for \"How many recipients unsubscribed from ","description":"Get unsubscribe counts and unsubscribe-link deliveries for a time range. Use for \"How many recipients unsubscribed from my MailChannels emails this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the range (inclusive), as YYYY-MM-DD or an ISO 8601 date-time. Defaults to the API's own default window when omitted.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the range (exclusive), as YYYY-MM-DD or an ISO 8601 date-time.","title":"End Time"},"campaign_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages of this campaign ID; all campaigns when omitted.","title":"Campaign Id"},"interval":{"anyOf":[{"enum":["hour","day","week","month"],"type":"string"},{"type":"null"}],"default":"day","description":"Aggregation interval for the buckets.","title":"Interval"}},"title":"get_recipient_behaviour_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sender_metrics":{"post":{"operationId":"get_sender_metrics","summary":"Rank campaigns or sub-accounts by sending volume with processed, delivered, bounced and dropped counts. Use for \"Which M","description":"Rank campaigns or sub-accounts by sending volume with processed, delivered, bounced and dropped counts. Use for \"Which MailChannels sub-account sends the most email\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sender_type":{"description":"What to rank: campaigns or sub-accounts.","enum":["campaigns","sub-accounts"],"title":"Sender Type","type":"string"},"start_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the range (inclusive), as YYYY-MM-DD or an ISO 8601 date-time. Defaults to the API's own default window when omitted.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"End of the range (exclusive), as YYYY-MM-DD or an ISO 8601 date-time.","title":"End Time"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many senders to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many senders to skip.","title":"Offset"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort by total messages.","title":"Sort Order"}},"required":["sender_type"],"title":"get_sender_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_suppressions":{"post":{"operationId":"list_suppressions","summary":"List suppression list entries (recipients that will not be emailed) with source, types, sender and creation time. Use fo","description":"List suppression list entries (recipients that will not be emailed) with source, types, sender and creation time. Use for \"Which recipients are on my MailChannels suppression list\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"recipient":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only this recipient email address.","title":"Recipient"},"source":{"anyOf":[{"enum":["api","unsubscribe_link","list_unsubscribe","hard_bounce","spam_complaint"],"type":"string"},{"type":"null"}],"default":null,"description":"Only entries added by this source.","title":"Source"},"created_after":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only entries created after this date or date-time (YYYY-MM-DD or ISO 8601).","title":"Created After"},"created_before":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only entries created before this date or date-time.","title":"Created Before"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many entries to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many entries to skip.","title":"Offset"}},"title":"list_suppressionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sub_accounts":{"post":{"operationId":"list_sub_accounts","summary":"List sub-accounts of the parent account with company name, handle and enabled flag. Use for \"What sub-accounts does my M","description":"List sub-accounts of the parent account with company name, handle and enabled flag. Use for \"What sub-accounts does my MailChannels account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many sub-accounts to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many to skip.","title":"Offset"}},"title":"list_sub_accountsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dkim_keys":{"post":{"operationId":"list_dkim_keys","summary":"List DKIM keys of a domain with selector, algorithm, status and creation time; optionally include the suggested DNS reco","description":"List DKIM keys of a domain with selector, algorithm, status and creation time; optionally include the suggested DNS record. Use for \"What DKIM keys exist for example.com in MailChannels\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"The sending domain, for example example.com.","maxLength":200,"title":"Domain","type":"string"},"selector":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the key with this selector.","title":"Selector"},"status":{"anyOf":[{"enum":["active","retired","revoked","rotated"],"type":"string"},{"type":"null"}],"default":null,"description":"Only keys with this status.","title":"Status"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many keys to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many keys to skip.","title":"Offset"},"include_dns_record":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include the suggested DKIM DNS record for each key.","title":"Include Dns Record"}},"required":["domain"],"title":"list_dkim_keysArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tracking_domains":{"post":{"operationId":"list_tracking_domains","summary":"List custom tracking domains used for click, open and unsubscribe links with hostname, scope and status. Use for \"Which ","description":"List custom tracking domains used for click, open and unsubscribe links with hostname, scope and status. Use for \"Which custom tracking domains are set up in MailChannels\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the domain with this label.","title":"Name"},"status":{"anyOf":[{"enum":["active","disabled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only domains with this status.","title":"Status"},"scope":{"anyOf":[{"enum":["click","open","unsubscribe"],"type":"string"},{"type":"null"}],"default":null,"description":"Only domains with this scope.","title":"Scope"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many domains to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many to skip.","title":"Offset"}},"title":"list_tracking_domainsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhook endpoints registered for the account. Use for \"Which webhook URLs are registered in MailChannels\".","description":"List the webhook endpoints registered for the account. Use for \"Which webhook URLs are registered in MailChannels\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_webhooksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}