{"openapi":"3.0.0","info":{"description":"Mailercloud email marketing API — campaigns, contacts, lists, segments, tags, senders, templates, automations, webhooks and webforms via cloudapi.mailercloud.com/v1 (plain Authorization header with your API key, no Bearer prefix).","version":null},"servers":[{"description":"Mailercloud email marketing API — campaigns, contacts, lists, segments, tags, senders, templates, automations, webhooks and webforms via cloudapi.mailercloud.com/v1 (plain Authorization header with your API key, no Bearer prefix).","url":"https://api.apirails.com/mailercloud"}],"paths":{"/client/plan":{"get":{"tags":["Account"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/client/plan"},"summary":"Client Details","description":"Client Details — API to get current user details","security":[{"bearerAuth":[]}]}},"/automations":{"post":{"tags":["Automations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/automations"},"summary":"Create Automation","description":"Create Automation — API to create an advanced automation in a single request. `name` and `nodes` are required. `auto_publish` is optional (defaults to `false` = draft). `timezone`, `start_time`, `end_time`, `allow_re_enrollment`, `re_enroll_interval`, `re_enroll_unit` are optional. The automation is declared as a directed graph of nodes: exactly one trigger node, plus any number of action / wait / condition nodes wired via `parent_id`. Caller-supplied node ids (`id`, `parent_id`, `target_id`) ar","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_re_enrollment":{"type":"boolean","description":"allow_re_enrollment (body parameter)","enum":[true,false]},"auto_publish":{"type":"boolean","description":"auto_publish (body parameter)","enum":[true,false]},"end_time":{"type":"string","description":"end_time (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true},"nodes":{"type":"array","description":"nodes (body parameter)","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"type (body parameter)","required":true,"enum":["trigger","wait_for_period","wait_until_time","wait_for_event","if_else","random_split","goto","delete_contact","update_contact_property","add_tag","remove_tag","add_to_list","remove_from_list"]},"allow_import":{"type":"boolean","description":"allow_import (body parameter)","enum":[true,false]},"branch":{"type":"string","description":"branch (body parameter)","enum":["yes","no"]},"campaign":{"type":"string","description":"campaign (body parameter)"},"date":{"type":"string","description":"date (body parameter)"},"day":{"type":"number","description":"day (body parameter)"},"days":{"type":"number","description":"days (body parameter)"},"event":{"type":"string","description":"event (body parameter)"},"filters":{"type":"array","description":"filters (body parameter)"},"hours":{"type":"number","description":"hours (body parameter)"},"is_recurring":{"type":"boolean","description":"is_recurring (body parameter)","enum":[true,false]},"list":{"type":"string","description":"list (body parameter)"},"minutes":{"type":"number","description":"minutes (body parameter)"},"mode":{"type":"string","description":"mode (body parameter)","enum":["time_of_day","day_of_week","day_of_month","specific_date"]},"parent_id":{"type":"string","description":"parent_id (body parameter)"},"property":{"type":"string","description":"property (body parameter)"},"property_condition":{"type":"string","description":"property_condition (body parameter)","enum":["equals","not_equals","is_known","is_unknown","contains","does_not_contain","starts_with","ends_with"]},"property_value":{"type":"string","description":"property_value (body parameter)"},"set_time_limit":{"type":"boolean","description":"set_time_limit (body parameter)","enum":[true,false]},"tag":{"type":"string","description":"tag (body parameter)"},"tags":{"type":"array","description":"tags (body parameter)"},"target_id":{"type":"string","description":"target_id (body parameter)"},"time":{"type":"string","description":"time (body parameter)"},"trigger":{"type":"string","description":"trigger (body parameter)","enum":["list_subscribed","audience_subscribed","webform_submitted","contact_added_via_api","any_property_changed","list_property_changed","campaign_opened","campaign_not_opened","campaign_clicked","campaign_not_clicked","campaign_sent","date_property","tag_added"]},"value":{"type":"string","description":"value (body parameter)"},"wait_for":{"type":"number","description":"wait_for (body parameter)"},"wait_unit":{"type":"string","description":"wait_unit (body parameter)","enum":["hours","days","weeks"]},"webform":{"type":"string","description":"webform (body parameter)"},"weeks":{"type":"array","description":"weeks (body parameter)"},"when":{"type":"string","description":"when (body parameter)","enum":["same_day","before","after"]}}}},"re_enroll_interval":{"type":"number","description":"re_enroll_interval (body parameter)"},"re_enroll_unit":{"type":"string","description":"re_enroll_unit (body parameter)","enum":["hours","days","weeks"]},"start_time":{"type":"string","description":"start_time (body parameter)"},"timezone":{"type":"string","description":"timezone (body parameter)"}}},"example":{"allow_re_enrollment":"","auto_publish":"","end_time":"end_time_value","name":"name_value","nodes":[],"re_enroll_interval":1,"re_enroll_unit":"hours","start_time":"start_time_value","timezone":"timezone_value"}}}}}},"/automations/{id}":{"post":{"tags":["Automations"],"parameters":[{"name":"id","in":"path","description":"id (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/automations/{id}"},"summary":"Get Automation Details","description":"Get Automation Details — Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"node_type":{"type":"string","description":"node_type (body parameter)"}}},"example":{"node_type":"node_type_value"}}}}}},"/campaign":{"post":{"tags":["Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign"},"summary":"Create Campaign","description":"Create Campaign — > A newer version of this endpoint with more options is available: [Create Campaign (v2)](/api-reference/campaigns/create-campaign-v2). API for creating an email campaign. For creating a campaign, HTML or plain text and list id or segment are mandatory.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_preheader":{"type":"string","description":"email_preheader (body parameter)"},"html":{"type":"string","description":"html (body parameter)"},"list_ids":{"type":"array","description":"list_ids (body parameter)","required":true,"items":{"type":"string"}},"mailing_preference":{"type":"boolean","description":"mailing_preference (body parameter)","enum":[true,false]},"name":{"type":"string","description":"name (body parameter)","required":true},"pause_rules":{"type":"object","description":"pause_rules (body parameter)","properties":{"pause_condition":{"type":"string","description":"pause_condition (body parameter)","required":true},"pause_criteria":{"type":"string","description":"pause_criteria (body parameter)","required":true},"pause_limit":{"type":"number","description":"pause_limit (body parameter)","required":true},"pause_target":{"type":"number","description":"pause_target (body parameter)","required":true},"wait_time":{"type":"number","description":"wait_time (body parameter)","required":true}}},"permission_reminder":{"type":"string","description":"permission_reminder (body parameter)"},"plain_text":{"type":"string","description":"plain_text (body parameter)"},"reply_email":{"type":"string","description":"reply_email (body parameter)"},"report_spam":{"type":"boolean","description":"report_spam (body parameter)","enum":[true,false]},"rules":{"type":"object","description":"rules (body parameter)","properties":{"contacts_order":{"type":"string","description":"contacts_order (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)"}}},"scheduled_at":{"type":"string","description":"scheduled_at (body parameter)"},"segments":{"type":"string","description":"segments (body parameter)"},"sender":{"type":"object","description":"sender (body parameter)","required":true,"properties":{"sender_email":{"type":"string","description":"sender_email (body parameter)","required":true},"sender_name":{"type":"string","description":"sender_name (body parameter)","required":true}}},"subject":{"type":"string","description":"subject (body parameter)","required":true},"viewin_browser":{"type":"boolean","description":"viewin_browser (body parameter)","enum":[true,false]}}},"example":{"email_preheader":"email_preheader_value","html":"html_value","list_ids":[],"mailing_preference":true,"name":"name_value","pause_rules":{},"permission_reminder":"permission_reminder_value","plain_text":"plain_text_value","reply_email":"reply_email_value","report_spam":true,"rules":{},"scheduled_at":"scheduled_at_value","segments":"segments_value","sender":{},"subject":"subject_value","viewin_browser":true}}}}}},"/campaign/domain/report/{id}":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/domain/report/{id}"},"summary":"Campaign Domain Report","description":"Campaign Domain Report — This report contains statistics for the top-performing email domains in a campaign. The domains report allows you to break down your customers into groups according to their mailbox service provider.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"sort_field":{"type":"string","description":"sort_field (body parameter)"},"sort_order":{"type":"string","description":"sort_order (body parameter)"}}},"example":{"limit":1,"page":1,"sort_field":"sort_field_value","sort_order":"sort_order_value"}}}}}},"/campaign/list":{"post":{"tags":["Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/list"},"summary":"Campaign List","description":"Campaign List — Get the details of all the campaigns you have created.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"date_from":{"type":"string","description":"date_from (body parameter)"},"date_to":{"type":"string","description":"date_to (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"},"sender_email":{"type":"string","description":"sender_email (body parameter)"},"sort_field":{"type":"string","description":"sort_field (body parameter)"},"sort_order":{"type":"string","description":"sort_order (body parameter)"},"status":{"type":"string","description":"status (body parameter)"}}},"example":{"date_from":"date_from_value","date_to":"date_to_value","limit":1,"page":1,"search":"search_value","sender_email":"sender_email_value","sort_field":"sort_field_value","sort_order":"sort_order_value","status":"status_value"}}}}}},"/campaign/save":{"post":{"tags":["Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/save"},"summary":"Create Campaign (v2)","description":"Create Campaign (v2) — **The newer version of Create Campaign with additional options — prefer this endpoint for new integrations.** **Required:** `name`, `subject`, and `sender` (with `sender_name` + `sender_email`). **Content:** provide `html` or `plain_text`. **Audience:** provide at least one of `list_ids`, `segments`, or `tag_ids`.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_preheader":{"type":"string","description":"email_preheader (body parameter)"},"exclude_list_ids":{"type":"array","description":"exclude_list_ids (body parameter)","items":{"type":"string"}},"exclude_segments":{"type":"array","description":"exclude_segments (body parameter)","items":{"type":"string"}},"exclude_tag_ids":{"type":"array","description":"exclude_tag_ids (body parameter)","items":{"type":"string"}},"frequency_cap":{"type":"string","description":"frequency_cap (body parameter)"},"html":{"type":"string","description":"html (body parameter)"},"is_publish":{"type":"string","description":"is_publish (body parameter)","enum":["0","1"]},"list_ids":{"type":"array","description":"list_ids (body parameter)","items":{"type":"string"}},"mailing_preference":{"type":"boolean","description":"mailing_preference (body parameter)","enum":[true,false]},"name":{"type":"string","description":"name (body parameter)","required":true},"pause_rules":{"type":"object","description":"pause_rules (body parameter)","properties":{"pause_condition":{"type":"string","description":"pause_condition (body parameter)","enum":["greater than","less than"]},"pause_criteria":{"type":"string","description":"pause_criteria (body parameter)","enum":["open","click"]},"pause_limit":{"type":"number","description":"pause_limit (body parameter)"},"pause_target":{"type":"number","description":"pause_target (body parameter)"},"wait_time":{"type":"number","description":"wait_time (body parameter)"}}},"permission_reminder":{"type":"string","description":"permission_reminder (body parameter)"},"plain_text":{"type":"string","description":"plain_text (body parameter)"},"reply_email":{"type":"string","description":"reply_email (body parameter)"},"reply_id":{"type":"string","description":"reply_id (body parameter)"},"report_spam":{"type":"boolean","description":"report_spam (body parameter)","enum":[true,false]},"rules":{"type":"object","description":"rules (body parameter)","properties":{"contacts_order":{"type":"string","description":"contacts_order (body parameter)","enum":["first","last"]},"limit":{"type":"number","description":"limit (body parameter)"}}},"scheduled_at":{"type":"string","description":"scheduled_at (body parameter)"},"segments":{"type":"array","description":"segments (body parameter)","items":{"type":"string"}},"sender":{"type":"object","description":"sender (body parameter)","required":true,"properties":{"sender_email":{"type":"string","description":"sender_email (body parameter)","required":true},"sender_name":{"type":"string","description":"sender_name (body parameter)","required":true}}},"sender_id":{"type":"array","description":"sender_id (body parameter)","items":{"type":"string"}},"subject":{"type":"string","description":"subject (body parameter)","required":true},"tag_id":{"type":"string","description":"tag_id (body parameter)"},"tag_ids":{"type":"array","description":"tag_ids (body parameter)","items":{"type":"string"}},"tag_name":{"type":"string","description":"tag_name (body parameter)"}}},"example":{"email_preheader":"email_preheader_value","exclude_list_ids":[],"exclude_segments":[],"exclude_tag_ids":[],"frequency_cap":"frequency_cap_value","html":"html_value","is_publish":"0","list_ids":[],"mailing_preference":true,"name":"name_value","pause_rules":{},"permission_reminder":"permission_reminder_value","plain_text":"plain_text_value","reply_email":"reply_email_value","reply_id":"reply_id_value","report_spam":true,"rules":{},"scheduled_at":"scheduled_at_value","segments":[],"sender":{},"sender_id":[],"subject":"subject_value","tag_id":"tag_id_value","tag_ids":[],"tag_name":"tag_name_value"}}}}}},"/campaign/schedule/{id}":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Campaign Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/schedule/{id}"},"summary":"Schedule Campaign","description":"Schedule Campaign — API for scheduling campaign. If the schedule_at is not given, the campaign will schedule for the current time.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"scheduled_at":{"type":"string","description":"scheduled_at (body parameter)"}}},"example":{"scheduled_at":"scheduled_at_value"}}}}}},"/campaign/testmail-groups/list":{"post":{"tags":["Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/testmail-groups/list"},"summary":"Testmail Group List","description":"Testmail Group List — Get the details of all the testmail groups you have created.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"search":{"type":"string","description":"search (body parameter)"}}},"example":{"search":"search_value"}}}}}},"/campaign/testmail/{id}":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Campaign Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/testmail/{id}"},"summary":"Send a Test Email","description":"Send a Test Email — Send a test email.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email (body parameter)"},"testmail_group":{"type":"string","description":"testmail_group (body parameter)"}}},"example":{"email":"email_value","testmail_group":"testmail_group_value"}}}}}},"/campaign/{id}":{"get":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Campaign Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/{id}"},"summary":"Get Single Campaign Details","description":"Get Single Campaign Details — Get the details of a single campaign.","security":[{"bearerAuth":[]}]},"put":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Campaign Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/{id}"},"summary":"Update Campaign","description":"Update Campaign — API for updating the campaign. Can't change or edit the list, segments, pause_rule, rules for the campaigns in sending status. Pause the campaign to edit the scheduled date.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_preheader":{"type":"string","description":"email_preheader (body parameter)"},"html":{"type":"string","description":"html (body parameter)"},"list_ids":{"type":"array","description":"list_ids (body parameter)","items":{"type":"string"}},"mailing_preference":{"type":"boolean","description":"mailing_preference (body parameter)","enum":[true,false]},"name":{"type":"string","description":"name (body parameter)"},"pause_rules":{"type":"object","description":"pause_rules (body parameter)","properties":{"pause_condition":{"type":"string","description":"pause_condition (body parameter)"},"pause_criteria":{"type":"string","description":"pause_criteria (body parameter)"},"pause_limit":{"type":"number","description":"pause_limit (body parameter)"},"pause_target":{"type":"number","description":"pause_target (body parameter)"},"wait_time":{"type":"number","description":"wait_time (body parameter)"}}},"permission_reminder":{"type":"string","description":"permission_reminder (body parameter)"},"plain_text":{"type":"string","description":"plain_text (body parameter)"},"reply_email":{"type":"string","description":"reply_email (body parameter)"},"report_spam":{"type":"boolean","description":"report_spam (body parameter)","enum":[true,false]},"rules":{"type":"object","description":"rules (body parameter)","properties":{"contacts_order":{"type":"string","description":"contacts_order (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)"}}},"scheduled_at":{"type":"string","description":"scheduled_at (body parameter)"},"segments":{"type":"string","description":"segments (body parameter)"},"sender":{"type":"object","description":"sender (body parameter)","properties":{"sender_email":{"type":"string","description":"sender_email (body parameter)"},"sender_name":{"type":"string","description":"sender_name (body parameter)"}}},"subject":{"type":"string","description":"subject (body parameter)"},"viewin_browser":{"type":"boolean","description":"viewin_browser (body parameter)","enum":[true,false]}}},"example":{"email_preheader":"email_preheader_value","html":"html_value","list_ids":[],"mailing_preference":true,"name":"name_value","pause_rules":{},"permission_reminder":"permission_reminder_value","plain_text":"plain_text_value","reply_email":"reply_email_value","report_spam":true,"rules":{},"scheduled_at":"scheduled_at_value","segments":"segments_value","sender":{},"subject":"subject_value","viewin_browser":true}}}}}},"/campaign/{id}/clicks":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Encrypted campaign id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/{id}/clicks"},"summary":"List Campaign Clicks","description":"List Campaign Clicks — Get a paginated list of contacts who clicked a link in a specific campaign. Each row carries the contact's encrypted id, email, name, the tags currently assigned to the contact, the lists the contact currently belongs to (with their ids and names), and the time of the click in your account timezone. Each contact appears at most once in the response. If a contact clicked more than once, the time shown is the most recent click.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"date_from":{"type":"string","description":"date_from (body parameter)"},"date_to":{"type":"string","description":"date_to (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true}}},"example":{"date_from":"date_from_value","date_to":"date_to_value","limit":1,"page":1}}}}}},"/campaign/{id}/opens":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Encrypted campaign id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/{id}/opens"},"summary":"List Campaign Opens","description":"List Campaign Opens — Get a paginated list of contacts who opened a specific campaign. Each row carries the contact's encrypted id, email, name, the tags currently assigned to the contact, the lists the contact currently belongs to (with their ids and names), and the time of the open in your account timezone. Each contact appears at most once in the response. If a contact opened the campaign multiple times, the time shown is the most recent open.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"date_from":{"type":"string","description":"date_from (body parameter)"},"date_to":{"type":"string","description":"date_to (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true}}},"example":{"date_from":"date_from_value","date_to":"date_to_value","limit":1,"page":1}}}}}},"/campaign/{id}/unsubs":{"post":{"tags":["Campaigns"],"parameters":[{"name":"id","in":"path","description":"Encrypted campaign id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/campaign/{id}/unsubs"},"summary":"List Campaign Unsubscribes","description":"List Campaign Unsubscribes — Get a paginated list of contacts who unsubscribed via a specific campaign. Each row carries the contact's encrypted id, email, name, the tags currently assigned to the contact, the lists the contact currently belongs to (with their ids and names), the time of the unsubscribe in your account timezone, and the reason the contact gave (if any).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"date_from":{"type":"string","description":"date_from (body parameter)"},"date_to":{"type":"string","description":"date_to (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true}}},"example":{"date_from":"date_from_value","date_to":"date_to_value","limit":1,"page":1}}}}}},"/contact/search/{id}":{"post":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"List id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contact/search/{id}"},"summary":"Get Contacts in a List","description":"Get Contacts in a List — You can collect all your contacts on a single list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"}}},"example":{"limit":1,"page":1,"search":"search_value"}}}}}},"/contact/tag/remove":{"post":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contact/tag/remove"},"summary":"Remove Contact Tag","description":"Remove Contact Tag — API to remove contact-tags from individual contacts When you send a request, the API first checks if the contact already exists in your database. If the contact is found, the API will check if the tags you provided are valid. You can give both tag names or tag ids. The API allows you to remove contact-tags. You can do this in two ways: - By Contact ID: You can add the **contact ID** from your panel to remove tags. - By Email: Alternatively, you can use the **email ID** of th","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tag_ids":{"type":"array","description":"tag_ids (body parameter)","items":{"type":"string"}},"tag_names":{"type":"array","description":"tag_names (body parameter)","items":{"type":"string"}}}},"example":{"tag_ids":[],"tag_names":[]}}}}}},"/contacts":{"post":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contacts"},"summary":"Create Contact","description":"Create Contact — API for creating contact. For creating a contact, email and list id is required. If you try to create a contact that already exists, it gives an \"already exists\" message . You can add custom property data by mapping the property id : value. You can add contacts until your contact quota limit is reached. If you create a contact in a suppressed list and if this contact is also present in the active list, the contact will be removed from the active list to the suppressed list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"city":{"type":"string","description":"city (body parameter)"},"company_name":{"type":"string","description":"company_name (body parameter)"},"contact_type":{"type":"string","description":"contact_type (body parameter)"},"country":{"type":"string","description":"country (body parameter)"},"custom_fields":{"type":"object","description":"custom_fields (body parameter)","properties":{"enc_id1":{"type":"string","description":"enc_id1 (body parameter)"},"enc_id2":{"type":"number","description":"enc_id2 (body parameter)"}}},"department":{"type":"string","description":"department (body parameter)"},"email":{"type":"string","description":"email (body parameter)","required":true},"first_name":{"type":"string","description":"first_name (body parameter)"},"industry":{"type":"string","description":"industry (body parameter)"},"job_title":{"type":"string","description":"job_title (body parameter)"},"last_name":{"type":"string","description":"last_name (body parameter)"},"lead_source":{"type":"string","description":"lead_source (body parameter)"},"list_id":{"type":"string","description":"list_id (body parameter)","required":true},"middle_name":{"type":"string","description":"middle_name (body parameter)"},"phone":{"type":"string","description":"phone (body parameter)"},"postal_code":{"type":"string","description":"postal_code (body parameter)"},"salary":{"type":"number","description":"salary (body parameter)"},"state":{"type":"string","description":"state (body parameter)"},"tags":{"type":"array","description":"tags (body parameter)","items":{"type":"string"}}}},"example":{"city":"city_value","company_name":"company_name_value","contact_type":"active","country":"country_value","custom_fields":{},"department":"department_value","email":"email_value","first_name":"first_name_value","industry":"industry_value","job_title":"job_title_value","last_name":"last_name_value","lead_source":"lead_source_value","list_id":"list_id_value","middle_name":"middle_name_value","phone":"phone_value","postal_code":"postal_code_value","salary":1,"state":"state_value","tags":[]}}}}}},"/contacts/batch":{"post":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contacts/batch"},"summary":"Create Batch Contact","description":"Create Batch Contact — Create a Batch contact. You can create a maximum of 50 contact through this API.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contacts":{"type":"array","description":"contacts (body parameter)","required":true,"items":{"type":"object","properties":{"city":{"type":"string","description":"city (body parameter)"},"company_name":{"type":"string","description":"company_name (body parameter)"},"contact_type":{"type":"string","description":"contact_type (body parameter)"},"country":{"type":"string","description":"country (body parameter)"},"custom_fields":{"type":"object","description":"custom_fields (body parameter)"},"department":{"type":"string","description":"department (body parameter)"},"email":{"type":"string","description":"email (body parameter)","required":true},"industry":{"type":"string","description":"industry (body parameter)"},"job_title":{"type":"string","description":"job_title (body parameter)"},"last_name":{"type":"string","description":"last_name (body parameter)"},"lead_source":{"type":"string","description":"lead_source (body parameter)"},"middle_name":{"type":"string","description":"middle_name (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"phone":{"type":"string","description":"phone (body parameter)"},"postal_code":{"type":"string","description":"postal_code (body parameter)"},"salary":{"type":"number","description":"salary (body parameter)"},"state":{"type":"string","description":"state (body parameter)"},"tags":{"type":"array","description":"tags (body parameter)"}}}},"list_id":{"type":"string","description":"list_id (body parameter)","required":true}}},"example":{"contacts":[],"list_id":"list_id_value"}}}}}},"/contacts/upsert":{"post":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contacts/upsert"},"summary":"Create or Update Contact","description":"Create or Update Contact — API to manage your contacts, allowing you to either create new contacts or update existing ones based on your needs. When you send a request, the API first checks if the contact already exists in your database. If the contact is found, the API will automatically update the existing contact with the new information provided. This ensures that your contact list remains up-to-date without creating duplicates. **Custom Property Data:** The API allows you to add custom prop","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"city":{"type":"string","description":"city (body parameter)"},"company_name":{"type":"string","description":"company_name (body parameter)"},"contact_type":{"type":"string","description":"contact_type (body parameter)"},"country":{"type":"string","description":"country (body parameter)"},"custom_fields":{"type":"object","description":"custom_fields (body parameter)","properties":{"enc_id1":{"type":"string","description":"enc_id1 (body parameter)"},"personalisation_tag_4":{"type":"number","description":"personalisation_tag_4 (body parameter)"}}},"department":{"type":"string","description":"department (body parameter)"},"email":{"type":"string","description":"email (body parameter)"},"first_name":{"type":"string","description":"first_name (body parameter)"},"industry":{"type":"string","description":"industry (body parameter)"},"job_title":{"type":"string","description":"job_title (body parameter)"},"last_name":{"type":"string","description":"last_name (body parameter)"},"lead_source":{"type":"string","description":"lead_source (body parameter)"},"list_id":{"type":"string","description":"list_id (body parameter)"},"middle_name":{"type":"string","description":"middle_name (body parameter)"},"phone":{"type":"string","description":"phone (body parameter)"},"postal_code":{"type":"string","description":"postal_code (body parameter)"},"salary":{"type":"number","description":"salary (body parameter)"},"state":{"type":"string","description":"state (body parameter)"},"tags":{"type":"array","description":"tags (body parameter)","items":{"type":"string"}}}},"example":{"city":"city_value","company_name":"company_name_value","contact_type":"contact_type_value","country":"country_value","custom_fields":{},"department":"department_value","email":"email_value","first_name":"first_name_value","industry":"industry_value","job_title":"job_title_value","last_name":"last_name_value","lead_source":"lead_source_value","list_id":"list_id_value","middle_name":"middle_name_value","phone":"phone_value","postal_code":"postal_code_value","salary":1,"state":"state_value","tags":[]}}}}}},"/contacts/{id}":{"get":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Contact id or Email","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contacts/{id}"},"summary":"Get Contact Details","description":"Get Contact Details — Get contact details based on their Contact ID or Email","security":[{"bearerAuth":[]}]},"put":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Contact Id or Email","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contacts/{id}"},"summary":"Update Contact","description":"Update Contact — Update contact details based on contact ID or Email using this API. However, you can't update the list ID and email.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"city":{"type":"string","description":"city (body parameter)"},"company_name":{"type":"string","description":"company_name (body parameter)"},"contact_type":{"type":"string","description":"contact_type (body parameter)"},"country":{"type":"string","description":"country (body parameter)"},"custom_fields":{"type":"object","description":"custom_fields (body parameter)","properties":{"enc_id1":{"type":"string","description":"enc_id1 (body parameter)","required":true},"enc_id2":{"type":"number","description":"enc_id2 (body parameter)","required":true}}},"department":{"type":"string","description":"department (body parameter)"},"first_name":{"type":"string","description":"first_name (body parameter)"},"industry":{"type":"string","description":"industry (body parameter)"},"job_title":{"type":"string","description":"job_title (body parameter)"},"last_name":{"type":"string","description":"last_name (body parameter)"},"lead_source":{"type":"string","description":"lead_source (body parameter)"},"middle_name":{"type":"string","description":"middle_name (body parameter)"},"phone":{"type":"string","description":"phone (body parameter)"},"postal_code":{"type":"string","description":"postal_code (body parameter)"},"salary":{"type":"number","description":"salary (body parameter)"},"state":{"type":"string","description":"state (body parameter)"},"tags":{"type":"array","description":"tags (body parameter)","items":{"type":"string"}}}},"example":{"city":"city_value","company_name":"company_name_value","contact_type":"contact_type_value","country":"country_value","custom_fields":{},"department":"department_value","first_name":"first_name_value","industry":"industry_value","job_title":"job_title_value","last_name":"last_name_value","lead_source":"lead_source_value","middle_name":"middle_name_value","phone":"phone_value","postal_code":"postal_code_value","salary":1,"state":"state_value","tags":[]}}}}},"delete":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"Contact id or Email","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contacts/{id}"},"summary":"Delete Contact","description":"Delete Contact — Delete a contact based on their ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/contact/property":{"post":{"tags":["Custom Properties"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contact/property"},"summary":"Create Property","description":"Create Property — API for creating custom property of contacts. Custom properties store specific information for contact records in Mailercloud. You are allowed to create a maximum of 100 properties.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"type (body parameter)","required":true},"description":{"type":"string","description":"description (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"type":"type_value","description":"description_value","name":"name_value"}}}}}},"/contact/property/search":{"post":{"tags":["Custom Properties"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contact/property/search"},"summary":"List Property","description":"List Property — Using this API, you can list all the properties of your contacts in your Mailercloud account. You can also make segments based on these properties","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"type (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"}}},"example":{"type":"type_value","limit":1,"page":1,"search":"search_value"}}}}}},"/contact/property/{id}":{"patch":{"tags":["Custom Properties"],"parameters":[{"name":"id","in":"path","description":"Custom Property Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contact/property/{id}"},"summary":"Update Property","description":"Update Property — API for updating custom property of contacts. Editing custom property type using this API is not possible. You can only edit the name and description.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description (body parameter)"},"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"description":"description_value","name":"name_value"}}}}},"delete":{"tags":["Custom Properties"],"parameters":[{"name":"id","in":"path","description":"Custom property Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/contact/property/{id}"},"summary":"Delete Property","description":"Delete Property — API for deleting custom property of contacts. If the property is used in a webform you won't be able to delete it.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/inbox-tracking":{"post":{"tags":["Inbox Tracker"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/inbox-tracking"},"summary":"Inbox-tracking","description":"Inbox-tracking — API to get inbox tracking details. Date period is required (date_from & date_to), campaign_id is optional, domain is optional","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"campaign_id":{"type":"string","description":"campaign_id (body parameter)"},"date_from":{"type":"string","description":"date_from (body parameter)","required":true},"date_to":{"type":"string","description":"date_to (body parameter)","required":true},"domain":{"type":"string","description":"domain (body parameter)"}}},"example":{"campaign_id":"campaign_id_value","date_from":"date_from_value","date_to":"date_to_value","domain":"domain_value"}}}}}},"/list":{"post":{"tags":["Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/list"},"summary":"Create a New List","description":"Create a New List — Your Mailercloud list, also known as your recipient, is where you store and manage all of your contacts.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"list_type":{"type":"number","description":"list_type (body parameter)","required":true},"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"list_type":1,"name":"name_value"}}}}}},"/list/{id}":{"get":{"tags":["Lists"],"parameters":[{"name":"id","in":"path","description":"List Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/list/{id}"},"summary":"Get Single List Details","description":"Get Single List Details — Get single list details based on id.","security":[{"bearerAuth":[]}]},"patch":{"tags":["Lists"],"parameters":[{"name":"id","in":"path","description":"List Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/list/{id}"},"summary":"Update a List","description":"Update a List — Update the details of a specific list by id. However, you can only update the names using this API","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"name":"name_value"}}}}},"delete":{"tags":["Lists"],"parameters":[{"name":"id","in":"path","description":"List Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/list/{id}"},"summary":"Delete a List","description":"Delete a List — This API deletes a specific list by id. However, you can't delete your list if its used in an active campaign , active automation or in an active webform .","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/lists/search":{"post":{"tags":["Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/lists/search"},"summary":"List Lists","description":"List Lists — Use this API to return an array of all of your contact lists. You can filter, search and sort list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"list_type":{"type":"number","description":"list_type (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search_name":{"type":"string","description":"search_name (body parameter)"},"sort_field":{"type":"string","description":"sort_field (body parameter)"},"sort_order":{"type":"string","description":"sort_order (body parameter)"}}},"example":{"limit":1,"list_type":1,"page":1,"search_name":"search_name_value","sort_field":"sort_field_value","sort_order":"sort_order_value"}}}}}},"/segment/search":{"post":{"tags":["Segments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/segment/search"},"summary":"List Segment","description":"List Segment — List all your created segments.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)","required":true},"sort_field":{"type":"string","description":"sort_field (body parameter)","required":true},"sort_order":{"type":"string","description":"sort_order (body parameter)","required":true}}},"example":{"limit":1,"page":1,"search":"search_value","sort_field":"sort_field_value","sort_order":"sort_order_value"}}}}}},"/segments":{"post":{"tags":["Segments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/segments"},"summary":"Create Segment","description":"Create Segment — API to create a segment in a single request. `name`, `match` and `rules` are required. `lists` is optional - if omitted, the segment evaluates against all contacts. A segment is a dynamic contact filter built from a list of rules. Each rule belongs to one of 4 filter_types: `contact_details` (built-in contact fields), `contact_property` (custom properties), `tag` (contact tags), or `activity` (campaign / automation / engagement events). The `match` field controls whether ALL rul","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"lists":{"type":"array","description":"lists (body parameter)","items":{"type":"string"}},"match":{"type":"string","description":"match (body parameter)","required":true,"enum":["all","any"]},"name":{"type":"string","description":"name (body parameter)","required":true},"rules":{"type":"array","description":"rules (body parameter)","required":true,"items":{"type":"object","properties":{"category":{"type":"string","description":"category (body parameter)","enum":["campaign","automation","webform","list","audience","engagement_status","global_engagers","global_openers","subscriber_opened","subscriber_clicked"]},"activity":{"type":"string","description":"activity (body parameter)"},"field":{"type":"string","description":"field (body parameter)"},"filter_by":{"type":"string","description":"filter_by (body parameter)"},"filter_type":{"type":"string","description":"filter_type (body parameter)","required":true,"enum":["contact_details","contact_property","tag","activity"]},"operator":{"type":"string","description":"operator (body parameter)"},"property_type":{"type":"string","description":"property_type (body parameter)","enum":["text","number","date"]},"value":{"type":"string","description":"value (body parameter)"}}}}}},"example":{"lists":[],"match":"all","name":"name_value","rules":[]}}}}}},"/segments/{id}":{"put":{"tags":["Segments"],"parameters":[{"name":"id","in":"path","description":"Segment ID to update.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/segments/{id}"},"summary":"Update a Segment","description":"Update a Segment — Update an existing segment by id. The full segment definition is replaced - this is NOT a partial update. Send the complete `name`, `match`, `rules` (and optional `lists`) on every call. On success, the segment's `active_count` is recomputed asynchronously. `GET /v1/segments/{id}` will return `count_status: pending` until the recount finishes (seconds to minutes), then `ready`. Field vocabulary, operator families, and value shapes match the create endpoint - see POST /v1/segme","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"lists":{"type":"array","description":"lists (body parameter)","items":{"type":"string"}},"match":{"type":"string","description":"match (body parameter)","required":true,"enum":["all","any"]},"name":{"type":"string","description":"name (body parameter)","required":true},"rules":{"type":"array","description":"rules (body parameter)","required":true,"items":{"type":"object","properties":{"category":{"type":"string","description":"category (body parameter)","enum":["campaign","automation","webform","list","audience","engagement_status","global_engagers","global_openers","subscriber_opened","subscriber_clicked"]},"activity":{"type":"string","description":"activity (body parameter)"},"field":{"type":"string","description":"field (body parameter)"},"filter_by":{"type":"string","description":"filter_by (body parameter)"},"filter_type":{"type":"string","description":"filter_type (body parameter)","required":true,"enum":["contact_details","contact_property","tag","activity"]},"operator":{"type":"string","description":"operator (body parameter)"},"property_type":{"type":"string","description":"property_type (body parameter)","enum":["text","number","date"]},"value":{"type":"string","description":"value (body parameter)"}}}}}},"example":{"lists":[],"match":"all","name":"name_value","rules":[]}}}}}},"/reply-emails/search":{"post":{"tags":["Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/reply-emails/search"},"summary":"List Reply Emails","description":"List Reply Emails — Use this API to return an array of all your active reply-to email addresses. You can filter and search reply emails with pagination.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"}}},"example":{"limit":1,"page":1,"search":"search_value"}}}}}},"/senders/search":{"post":{"tags":["Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/senders/search"},"summary":"List Senders","description":"List Senders — Use this API to return an array of all your active and verified sender email addresses with sender name and reply-to email. You can filter, search and sort senders.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"},"sort_field":{"type":"string","description":"sort_field (body parameter)"},"sort_order":{"type":"string","description":"sort_order (body parameter)"}}},"example":{"limit":1,"page":1,"search":"search_value","sort_field":"sort_field_value","sort_order":"sort_order_value"}}}}}},"/tags":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/tags"},"summary":"Create Tag","description":"Create Tag — API for creating tags for contacts and campaign.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"name":"name_value"}}}}}},"/tags/search":{"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/tags/search"},"summary":"List Tags","description":"List Tags — Using this API, you can list all the tags of your contacts and campaign in your Mailercloud account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"}}},"example":{"limit":1,"page":1,"search":"search_value"}}}}}},"/tags/{id}":{"put":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"Tag Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/tags/{id}"},"summary":"Update Tag","description":"Update Tag — API for updating tag name of contacts and campaign.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"name (body parameter)","required":true}}},"example":{"name":"name_value"}}}}},"delete":{"tags":["Tags"],"parameters":[{"name":"id","in":"path","description":"Tag Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/tags/{id}"},"summary":"Delete Tag","description":"Delete Tag — This API deletes a specific tag by id.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/templates/categories/list":{"get":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/templates/categories/list"},"summary":"Get Template Categories","description":"Get Template Categories — This API endpoint is used to list the template categories in Mailercloud.","security":[{"bearerAuth":[]}]}},"/templates/create":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/templates/create"},"summary":"Create Template","description":"Create Template — API to create a new template in Mailercloud. **Required Fields:** - name: Name of the template (required, max 100 characters, must be unique) - html: Specifies the HTML content (required) **Optional Fields:** - categoryId: Specifies the category ID of the template, you can get it from the **Get Template Categories** API. It would be 0 by default. - plainText: Specifies the plain text content","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"categoryId":{"type":"number","description":"categoryId (body parameter)"},"html":{"type":"string","description":"html (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"plainText":{"type":"string","description":"plainText (body parameter)"}}},"example":{"categoryId":1,"html":"html_value","name":"name_value","plainText":"plainText_value"}}}}}},"/templates/details":{"get":{"tags":["Templates"],"parameters":[{"name":"id","in":"query","description":"Template ID to look up. Provide either `name` or `id`.","required":false,"schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"Template name to look up. Provide either `name` or `id`.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/templates/details"},"summary":"Get Template by Name or ID","description":"Get Template by Name or ID — This endpoint retrieves the full details of an email template in mailercloud. You can fetch a template either by passing the template name or its ID in the query parameters. ```Name curl --request GET \\ --url https://cloudapi.mailercloud.com/v1/templates/details?name=example \\ --header 'Authorization: Your API Key here' ``` ```ID curl --request GET \\ --url https://cloudapi.mailercloud.com/v1/templates/details?id=abc \\ --header 'Authorization: Your API Key here' ```","security":[{"bearerAuth":[]}]}},"/templates/details/{id}":{"get":{"tags":["Templates"],"parameters":[{"name":"id","in":"path","description":"id (path parameter)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/templates/details/{id}"},"summary":"Get Template Details","description":"Get Template Details — This API endpoint is used to retrieve the details of a specific email template by its ID in Mailercloud.","security":[{"bearerAuth":[]}]}},"/templates/list":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/templates/list"},"summary":"List Templates","description":"List Templates — Get a list of your saved email templates. By default the response returns only template metadata (id, name, type, status, dates) — fast and small, ideal for building a template picker or dashboard. If you also want the full template body (HTML, AMP, and plain text) inlined in the same response, set `include_content: true`. This is useful when you need to render or display the templates yourself without making a separate `GET /templates/details/{id}` call for each one. You can fi","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category_id":{"type":"number","description":"category_id (body parameter)"},"include_content":{"type":"boolean","description":"include_content (body parameter)","enum":[true,false]},"limit":{"type":"number","description":"limit (body parameter)"},"page":{"type":"number","description":"page (body parameter)"},"search_name":{"type":"string","description":"search_name (body parameter)"},"sort_field":{"type":"string","description":"sort_field (body parameter)","enum":["name","created_date","modified_date"]},"sort_order":{"type":"string","description":"sort_order (body parameter)","enum":["asc","ASC","desc","DESC"]},"status":{"type":"string","description":"status (body parameter)"},"template_type":{"type":"string","description":"template_type (body parameter)"}}},"example":{"category_id":1,"include_content":"","limit":10,"page":1,"search_name":"search_name_value","sort_field":"modified_date","sort_order":"desc","status":"saved","template_type":"template_type_value"}}}}}},"/templates/update":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/templates/update"},"summary":"Update Template","description":"Update Template — This API allows you to update an existing email template in Mailercloud. You can update a template either by providing its id or by using the templateName — at least one of them is required. **Required Fields:** - id: The unique ID of the template you want to update. (Required if templateName is not provided.) - templateName: The name of the template you want to update. (Required if id is not provided.) - name: The new name for the template (maximum 100 characters). The name mu","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"categoryId":{"type":"number","description":"categoryId (body parameter)"},"html":{"type":"string","description":"html (body parameter)"},"name":{"type":"string","description":"name (body parameter)"},"plainText":{"type":"string","description":"plainText (body parameter)"},"templateName":{"type":"string","description":"templateName (body parameter)"}}},"example":{"categoryId":1,"html":"html_value","name":"name_value","plainText":"plainText_value","templateName":"templateName_value"}}}}}},"/webform/search":{"post":{"tags":["Webforms"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webform/search"},"summary":"Webform List","description":"Webform List — Use this API to return an array of all of your webforms. You can filter, search and sort webforms.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"date_from":{"type":"string","description":"date_from (body parameter)"},"date_to":{"type":"string","description":"date_to (body parameter)"},"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"},"sort_field":{"type":"string","description":"sort_field (body parameter)"},"sort_order":{"type":"string","description":"sort_order (body parameter)"},"status":{"type":"string","description":"status (body parameter)"}}},"example":{"date_from":"date_from_value","date_to":"date_to_value","limit":1,"page":1,"search":"search_value","sort_field":"sort_field_value","sort_order":"sort_order_value","status":"status_value"}}}}}},"/webhooks":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webhooks"},"summary":"Create a New Webhook","description":"Create a New Webhook — Mailercloud webhook is a mechanism that allows external systems to receive real-time updates and notifications about events occurring within your account.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"events":{"type":"array","description":"events (body parameter)","required":true,"items":{"type":"string"}},"name":{"type":"string","description":"name (body parameter)","required":true},"url":{"type":"string","description":"url (body parameter)","required":true}}},"example":{"events":[],"name":"name_value","url":"url_value"}}}}}},"/webhooks/detail/{id}":{"get":{"tags":["Webhooks"],"parameters":[{"name":"id","in":"path","description":"Webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webhooks/detail/{id}"},"summary":"Get Webhook Details","description":"Get Webhook Details — Get webhook details based on their ID","security":[{"bearerAuth":[]}]}},"/webhooks/search":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webhooks/search"},"summary":"Search and List Webhooks","description":"Search and List Webhooks — API to list all webhooks with the ability to search, filter, and sort the results.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"limit (body parameter)","required":true},"page":{"type":"number","description":"page (body parameter)","required":true},"search":{"type":"string","description":"search (body parameter)"},"sort_field":{"type":"string","description":"sort_field (body parameter)"},"sort_order":{"type":"string","description":"sort_order (body parameter)"}}},"example":{"limit":1,"page":1,"search":"search_value","sort_field":"sort_field_value","sort_order":"sort_order_value"}}}}}},"/webhooks/test":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webhooks/test"},"summary":"Test Webhook","description":"Test Webhook — API to send dummy trigger requests to the webhook URL for testing purposes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"parameter":{"type":"string","description":"parameter (body parameter)","required":true}}},"example":{"parameter":"parameter_value"}}}}}},"/webhooks/toggle/{id}":{"post":{"tags":["Webhooks"],"parameters":[{"name":"id","in":"path","description":"Webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webhooks/toggle/{id}"},"summary":"Toggle Webhook Status","description":"Toggle Webhook Status — API for deactivating or activating the status of a webhook.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"status":{"type":"string","description":"status (body parameter)","required":true}}},"example":{"status":"status_value"}}}}}},"/webhooks/{id}":{"put":{"tags":["Webhooks"],"parameters":[{"name":"id","in":"path","description":"Webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webhooks/{id}"},"summary":"Update a Webhook","description":"Update a Webhook — API for modifying webhook information. This allows you to update the webhook's name, URL, and events.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"events":{"type":"array","description":"events (body parameter)","required":true,"items":{"type":"string"}},"name":{"type":"string","description":"name (body parameter)","required":true},"url":{"type":"string","description":"url (body parameter)","required":true}}},"example":{"events":[],"name":"name_value","url":"url_value"}}}}},"delete":{"tags":["Webhooks"],"parameters":[{"name":"id","in":"path","description":"Webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://apidoc.mailercloud.com/","api_endpoint":"https://cloudapi.mailercloud.com/v1/webhooks/{id}"},"summary":"Delete a Webhook","description":"Delete a Webhook — This API deletes a specific webhook by id.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}