{"openapi":"3.0.0","info":{"description":"Email marketing API: subscribers, groups, campaigns, automations","version":null},"servers":[{"description":"Email marketing API: subscribers, groups, campaigns, automations","url":"https://api.apirails.com/mailerlite"}],"paths":{"/automations":{"get":{"tags":["Marketing Email"],"parameters":[{"name":"filter[enabled]","in":"query","description":"Must be one of the following: `true` (for active) and `false` (for inactive). Defaults to return all automations","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"filter[name]","in":"query","description":"Must be a string","required":false,"schema":{"type":"string","example":""}},{"name":"filter[group]","in":"query","description":"Must be a valid group id. Returns all automations that use the group in their trigger configuration","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Defaults to 1","required":false,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Defaults to 10","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/automations/#list-all-automations","api_endpoint":"https://connect.mailerlite.com/api/automations"},"summary":"List all automations","description":"If you want to get all of your automations use this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Automations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/automations/#create-draft-automation","api_endpoint":"https://connect.mailerlite.com/api/automations"},"summary":"Create draft automation","description":"If you want to create draft automations use this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Must be a string","required":true}}},"example":{"name":""}}}}}},"/automations/{automation_id}":{"get":{"tags":["Automations"],"parameters":[{"name":"automation_id","in":"path","description":"Automation id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/automations/#get-an-automation","api_endpoint":"https://connect.mailerlite.com/api/automations/{automation_id}"},"summary":"Get an automation","description":"If you want to fetch a specific automation you can use this `GET` endpoint","security":[{"bearerAuth":[]}]},"delete":{"tags":["Automations"],"parameters":[{"name":"automation_id","in":"path","description":"Automation id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/automations/#delete-automation","api_endpoint":"https://connect.mailerlite.com/api/automations/{automation_id}"},"summary":"Delete automation","description":"If you want to delete automation use this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/automations/{automation_id}/activity":{"get":{"tags":["Automations"],"parameters":[{"name":"automation_id","in":"path","description":"Automation id","required":true,"schema":{"type":"string","example":""}},{"name":"filter[status]","in":"query","description":"Must be one of the following: `completed`, `active`, `canceled`, `failed`","required":true,"schema":{"type":"string","example":""}},{"name":"filter[date_from]","in":"query","description":"Must be in the format `Y-m-d`. Relevant for statuses: `completed`, `canceled`, `failed`","required":false,"schema":{"type":"string","example":""}},{"name":"filter[date_to]","in":"query","description":"Must be in the format `Y-m-d`. Relevant for statuses: `completed`, `canceled`, `failed`","required":false,"schema":{"type":"string","example":""}},{"name":"filter[scheduled_from]","in":"query","description":"Must be in the format `Y-m-d`. Relevant for `active` status","required":false,"schema":{"type":"string","example":""}},{"name":"filter[scheduled_to]","in":"query","description":"Must be in the format `Y-m-d`. Relevant for `active` status","required":false,"schema":{"type":"string","example":""}},{"name":"filter[search]","in":"query","description":"Must be a subscriber email","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Defaults to 1","required":false,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Defaults to 10","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/automations/#get-the-subscriber-activity-for-an-automation","api_endpoint":"https://connect.mailerlite.com/api/automations/{automation_id}/activity"},"summary":"Get the subscriber activity for an automation","description":"If you want to fetch the subscriber activity for an automation use this `GET` request","security":[{"bearerAuth":[]}]}},"/batch":{"post":{"tags":["Batching"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/batching/","api_endpoint":"https://connect.mailerlite.com/api/batch"},"summary":"Batching","description":"The batch endpoint can be used to make multiple request to our api in a single call","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"requests":{"type":"array","description":"Array of objects containing required method and path properties and optional body","required":true,"items":{"type":"object","properties":{"method":{"type":"string","description":"The method type of the intended request: GET, POST, PUT, DELETE, PATCH","required":true},"path":{"type":"string","description":"The relative path of api endpoint. Must start with `api/`","required":true},"body":{"type":"object","description":"Objects containing properties for the body of the request"}}}}}},"example":{"requests":[]}}}}}},"/campaigns/languages":{"get":{"tags":["Campaign Languages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/campaign-languages/","api_endpoint":"https://connect.mailerlite.com/api/campaigns/languages"},"summary":"Campaign languages","description":"Use this `GET` request to get a list of all campaign languages available","security":[{"bearerAuth":[]}]}},"/campaigns":{"get":{"tags":["Campaigns"],"parameters":[{"name":"filter[status]","in":"query","description":"Must be one of the following: sent, draft, ready. Defaults to ready","required":false,"schema":{"type":"string","example":""}},{"name":"filter[type]","in":"query","description":"Must be one of the following: regular, ab, resend, rss. Defaults to return all","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Defaults to 25","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Defaults to 1","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/campaigns/#campaign-list","api_endpoint":"https://connect.mailerlite.com/api/campaigns"},"summary":"Campaign list","description":"If you want to get a list of all of your campaigns based on status or type use this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/campaigns/#create-a-campaign","api_endpoint":"https://connect.mailerlite.com/api/campaigns"},"summary":"Create a campaign","description":"You can create a campaign using this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum string length of 255 characters","required":true},"language_id":{"type":"number","description":"Used to define the language in the unsubscribe template. Must be a valid language id. Defaults to english"},"type":{"type":"string","description":"Must be one of the following: `regular`, `ab`, `resend`, `multivariate`. Types `resend` and `multivariate` are only available for accounts on growing or advanced plans","required":true},"emails":{"type":"array","description":"Must contain 1 email object item, unless campaign type is multivariate with content testing. For multivariate content test, it must contain the amount of content test variations","required":true,"items":{"type":"object","properties":{"subject":{"type":"string","description":"Maximum string length of 255 characters","required":true},"from_name":{"type":"string","description":"Maximum string length of 255 characters","required":true},"from":{"type":"string","description":"Must be a valid email address that has been already verified on MailerLite","required":true},"reply_to":{"type":"string","description":"Must be a valid `reply_to` email address that has been already verified on MailerLite"},"content":{"type":"string","description":"The content must be valid HTML, and the account must be on the Advanced plan. The email body must include an unsubscribe link, account name, address, and country. Otherwise, the default email footer will be added. Learn more."}}}},"groups":{"type":"array","description":"Must contain valid group ids belonging to the account","items":{"type":"string"}},"segments":{"type":"array","description":"Must contain valid segment ids belonging to the account. If both groups and segments are provided, only segments are used","items":{"type":"string"}},"ab_settings":{"type":"object","description":"All items of the array are required","properties":{"test_type":{"type":"string","description":"Must be one of the following: `subject`, `sender`, `sending_time`"},"select_winner_by":{"type":"string","description":"Must be one of the following: `o` (for opens), `c` (for clicks)"},"after_time_amount":{"type":"number","description":"Defines the amount of wait time for the ab testing"},"after_time_unit":{"type":"string","description":"Defines the unit of the wait time. Must be one of the following: `h` (for hours) or `d` (for days)"},"test_split":{"type":"number","description":"Must be between 5 and 25 for test types `subject` and `sender` and 100 for `sending_time` test type"},"b_value":{"type":"object","description":"Must contain the items for the b version of the campaign"}}},"resend_settings":{"type":"object","description":"All items of the array are required","properties":{"test_type":{"type":"string","description":"Must be one of the following: `subject`"},"select_winner_by":{"type":"string","description":"Defines the metric on which the recipients of the second email are selected. Must be one of the following: `o` (did not open the email), `c` (did not click the email)"},"b_value":{"type":"object","description":"Must contain the items for the auto resend of the campaign"}}},"resend_setings":{"type":"object","description":"Resend setings","properties":{"b_value":{"type":"object","description":"B value"}}},"multivariate_settings":{"type":"object","description":"All items of the array are required","properties":{"test_variants":{"type":"object","description":"Must contain all 4 test variant options: subject, sender, content and sending_time, however the total amount of email combinations must not exceed 8"}}},"multivarite_settings":{"type":"object","description":"Multivarite settings","properties":{"test_variants":{"type":"object","description":"Test variants"},"select_winner_by":{"type":"string","description":"Must be one of the following: `o` (for opens), `c` (for clicks)"},"after_time_amount":{"type":"number","description":"Defines the amount of wait time for the ab testing"},"after_time_unit":{"type":"string","description":"Defines the unit of the wait time. Must be one of the following: `h` (for hours) or `d` (for days)"},"test_split":{"type":"number","description":"Must be between 10 and 50 when sending time is not tested and 100 when sending time is tested"}}},"settings":{"type":"object","description":"Object containing campaign configuration options such as ecommerce tracking","properties":{"ecommerce_tracking":{"type":"boolean","description":"If campaign content contains ecommerce shop URLs, ecommerce link tracking will be enabled when set to true","enum":[true,false]}}}}},"example":{"name":"","language_id":"","type":"","emails":[],"groups":[],"segments":[],"ab_settings":{},"resend_settings":{},"resend_setings":{},"multivariate_settings":{},"multivarite_settings":{},"settings":{}}}}}}},"/campaigns/{campaign_id}":{"get":{"tags":["Campaigns"],"parameters":[{"name":"campaign_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://developers.mailerlite.com/api/campaigns/#get-a-campaign","api_endpoint":"https://connect.mailerlite.com/api/campaigns/{campaign_id}"},"summary":"Get a campaign","description":"You can fetch an existing campaign using this `GET` request","security":[{"bearerAuth":[]}]},"put":{"tags":["Campaigns"],"parameters":[{"name":"campaign_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://developers.mailerlite.com/api/campaigns/#update-campaign","api_endpoint":"https://connect.mailerlite.com/api/campaigns/{campaign_id}"},"summary":"Update campaign","description":"If you want to update a campaign that is currently with `draft` status, use this `PUT` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum string length of 255 characters","required":true},"language_id":{"type":"number","description":"Used to define the language in the unsubscribe template. Must be a valid language id. Defaults to english"},"emails":{"type":"array","description":"Must contain 1 email object item","required":true,"items":{"type":"object","properties":{"subject":{"type":"string","description":"Maximum string length of 255 characters","required":true},"from_name":{"type":"string","description":"Maximum string length of 255 characters","required":true}," from":{"type":"string","description":"Must be a valid email address that has been already verified on MailerLite","required":true},"content":{"type":"string","description":"The content must be valid HTML, and the account must be on the Advanced plan. The email body must include an unsubscribe link, account name, address, and country. Otherwise, the default email footer will be added. Learn more."}}}},"groups":{"type":"array","description":"Must contain valid group ids belonging to the account","items":{"type":"string"}},"segments":{"type":"array","description":"Must contain valid segment ids belonging to the account. If both groups and segments are provided, only segments are used","items":{"type":"string"}},"ab_settings":{"type":"object","description":"All items of the array are required","properties":{"test_type":{"type":"string","description":"Must be one of the following: `subject`, `sender`, `sending_time`"},"select_winner_by":{"type":"string","description":"Must be one of the following: `o` (for opens), `c` (for clicks)"},"after_time_amount":{"type":"number","description":"Defines the amount of wait time for the ab testing"},"after_time_unit":{"type":"string","description":"Defines the unit of the wait time. Must be one of the following: `h` (for hours) or `d` (for days)"},"test_split":{"type":"number","description":"Must be between 5 and 25 for test types `subject` and `sender` and 100 for `sending_time` test type"},"b_value":{"type":"object","description":"Must contain the items for the b version of the campaign"}}},"resend_settings":{"type":"object","description":"All items of the array are required","properties":{"test_type":{"type":"string","description":"Must be one of the following: `subject`"},"select_winner_by":{"type":"string","description":"Defines the metric on which the recipients of the second email are selected. Must be one of the following: `o` (did not open the email), `c` (did not click the email)"},"b_value":{"type":"object","description":"Must contain the items for the auto resend of the campaign"}}},"resend_setings":{"type":"object","description":"Resend setings","properties":{"b_value":{"type":"object","description":"B value"}}}}},"example":{"name":"","language_id":"","emails":[],"groups":[],"segments":[],"ab_settings":{},"resend_settings":{},"resend_setings":{}}}}}},"delete":{"tags":["Campaigns"],"parameters":[{"name":"campaign_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://developers.mailerlite.com/api/campaigns/#delete-a-campaign","api_endpoint":"https://connect.mailerlite.com/api/campaigns/{campaign_id}"},"summary":"Delete a campaign","description":"If you want to delete a campaign, use this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/campaigns/{campaign_id}/schedule":{"post":{"tags":["Campaigns"],"parameters":[{"name":"campaign_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://developers.mailerlite.com/api/campaigns/#schedule-a-campaign","api_endpoint":"https://connect.mailerlite.com/api/campaigns/{campaign_id}/schedule"},"summary":"Schedule a campaign","description":"If you want to schedule or send immediately a campaign, use this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"delivery":{"type":"string","description":"Must be one of the following: instant, scheduled, timezone_based, smart_sending","required":true},"schedule":{"type":"object","description":"Schedule","properties":{"date":{"type":"string","description":"Must be a date in the future. Campaign must not be of type AB test with sending time test type"},"hours":{"type":"string","description":"Must be a valid hour in HH format. Campaign must not be of type AB test with sending time test type"},"minutes":{"type":"string","description":"Must be a valid minute in ii format. Campaign must not be of type AB test with sending time test type"},"timezone_id":{"type":"number","description":"Must be a valid timezone id, defaults to the account's timezone id. Campaign must not be of type AB test with sending time test type"}}},"resend":{"type":"object","description":"Resend","properties":{"delivery":{"type":"string","description":"Must be Must be one of the following: day, scheduled"},"date":{"type":"string","description":"Must be a date in the future"},"hours":{"type":"string","description":"Must be a valid hour in HH format"},"minutes":{"type":"string","description":"Must be a valid minute in ii format"},"timezone_id":{"type":"number","description":"Must be a valid timezone id, defaults to the account's timezone id"}}},"sending_time_test_schedule":{"type":"array","description":"Must constain 2 sending times","required":true,"items":{"type":"object","properties":{"date":{"type":"string","description":"Must be a date in the future","required":true},"hours":{"type":"string","description":"Must be a valid hour in HH format.","required":true},"minutes":{"type":"string","description":"Must be a valid minute in ii format.","required":true},"timezone_id":{"type":"string","description":"Must be a valid timezone id, defaults to the account's timezone id.","required":true}}}}}},"example":{"delivery":"","schedule":{},"resend":{},"sending_time_test_schedule":[]}}}}}},"/campaigns/{campaign_id}/cancel":{"post":{"tags":["Campaigns"],"parameters":[{"name":"campaign_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://developers.mailerlite.com/api/campaigns/#cancel-a-ready-campaign","api_endpoint":"https://connect.mailerlite.com/api/campaigns/{campaign_id}/cancel"},"summary":"Cancel a ready campaign","description":"If you wish to cancel a campaign that is currently in a ready state, use this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/campaigns/{campaign_id}/reports/subscriber-activity":{"get":{"tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"Campaign id","required":true,"schema":{"type":"string","example":""}},{"name":"filter[type]","in":"query","description":"Must be one of following: `opened`, `unopened`, `clicked`, `unsubscribed`, `forwarded`, `hardbounced`, `softbounced`, `junk`. Defaults to returning all recipients","required":false,"schema":{"type":"string","example":""}},{"name":"filter[search]","in":"query","description":"Must be a subscriber email","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Must be one of the following: `10, 25, 50, 100`. Defaults to 50","required":false,"schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"Must be one of the following: `id`, `updated_at`, `clicks_count`, `opens_count`. Defaults to `id`","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Defaults to 1","required":false,"schema":{"type":"number","example":""}},{"name":"include","in":"query","description":"Additional resources to include in the response. Currently `subscriber` and `subscriber.groups` are supported.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/campaigns/#get-subscribers-activity-of-a-sent-campaign","api_endpoint":"https://connect.mailerlite.com/api/campaigns/{campaign_id}/reports/subscriber-activity"},"summary":"Get subscribers' activity of a sent campaign","description":"If you want to get the subscribers' activity of a campaign with status `sent` use this `GET` request","security":[{"bearerAuth":[]}]}},"/fields":{"get":{"tags":["Fields"],"parameters":[{"name":"limit","in":"query","description":"An account can have at most a 100 groups","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Count starts from 1","required":false,"schema":{"type":"number","example":""}},{"name":"filter[keyword]","in":"query","description":"Returns partial matches","required":false,"schema":{"type":"string","example":""}},{"name":"filter[type]","in":"query","description":"Can be one of the following: text, number or date","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Can be one of: `name`, `type`, Defaults to ascending order; prepend `-`, e.g. `-name` for descending order.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/fields/#list-all-fields","api_endpoint":"https://connect.mailerlite.com/api/fields"},"summary":"List all fields","description":"If you want to list all of your fields, use this `GET` endpoint","security":[{"bearerAuth":[]}]},"post":{"tags":["Fields"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/fields/#create-a-field","api_endpoint":"https://connect.mailerlite.com/api/fields"},"summary":"Create a field","description":"If you want to create a field that can be assigned to subscribers, use this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum length of 255 characters","required":true},"type":{"type":"string","description":"Can be text, number or date","required":true}}},"example":{"name":"","type":""}}}}}},"/fields/{field_id}":{"put":{"tags":["Fields"],"parameters":[{"name":"field_id","in":"path","description":"Field id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/fields/#update-a-field","api_endpoint":"https://connect.mailerlite.com/api/fields/{field_id}"},"summary":"Update a field","description":"If you want to update a field, use this `PUT` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum length of 255 characters","required":true}}},"example":{"name":""}}}}},"delete":{"tags":["Fields"],"parameters":[{"name":"field_id","in":"path","description":"Field id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/fields/#delete-a-field","api_endpoint":"https://connect.mailerlite.com/api/fields/{field_id}"},"summary":"Delete a field","description":"If you want to delete a field, use this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/forms/{type}":{"get":{"tags":["Forms"],"parameters":[{"name":"type","in":"path","description":"Type","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limit","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Count starts from 1","required":false,"schema":{"type":"number","example":""}},{"name":"filter[name]","in":"query","description":"Returns partial matches","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Can be one of: `created_at`, `name`, `conversions_count`, `opens_count`, `visitors`, `conversion_rate`, `last_registration_at`. Defaults to ascending order; prepend `-`, e.g. `-created_at` for descending order.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/forms/#list-all-forms","api_endpoint":"https://connect.mailerlite.com/api/forms/{type}"},"summary":"List all forms","description":"If you want to list all forms in your account, send this `GET` request","security":[{"bearerAuth":[]}]}},"/forms/{form_id}":{"get":{"tags":["Forms"],"parameters":[{"name":"form_id","in":"path","description":"Form id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/forms/#get-a-form","api_endpoint":"https://connect.mailerlite.com/api/forms/{form_id}"},"summary":"Get a form","description":"If you want to fetch a specific form you can use this `GET` request","security":[{"bearerAuth":[]}]},"put":{"tags":["Forms"],"parameters":[{"name":"form_id","in":"path","description":"Form id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/forms/#update-a-form","api_endpoint":"https://connect.mailerlite.com/api/forms/{form_id}"},"summary":"Update a form","description":"If you want to update a form use this `PUT` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum length of 255 characters","required":true}}},"example":{"name":""}}}}},"delete":{"tags":["Forms"],"parameters":[{"name":"form_id","in":"path","description":"Form id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/forms/#delete-a-form","api_endpoint":"https://connect.mailerlite.com/api/forms/{form_id}"},"summary":"Delete a form","description":"Use this `DELETE` request to delete a form","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/forms/{form_id}/subscribers":{"get":{"tags":["Forms"],"parameters":[{"name":"form_id","in":"path","description":"Form id","required":true,"schema":{"type":"string","example":""}},{"name":"filter[status]","in":"query","description":"Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk. Defaults to active.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Defaults to 25","required":false,"schema":{"type":"number","example":""}},{"name":"cursor","in":"query","description":"Defaults to first page. Cursor value available in response body","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/forms/#get-subscribers-who-signed-up-to-a-specific-form","api_endpoint":"https://connect.mailerlite.com/api/forms/{form_id}/subscribers"},"summary":"Get subscribers who signed up to a specific form","description":"If you want to fetch all the subscribers who signed up to a specific form use this `GET` request","security":[{"bearerAuth":[]}]}},"/groups":{"get":{"tags":["Groups"],"parameters":[{"name":"limit","in":"query","description":"An account can have at most a 1000 groups","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Count starts from 1","required":false,"schema":{"type":"number","example":""}},{"name":"filter[name]","in":"query","description":"Returns partial matches","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Can be one of: `name`, `total`, `open_rate`, `click_rate`, `created_at`. Defaults to ascending order; prepend `-`, e.g. `-total` for descending order.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#list-all-groups","api_endpoint":"https://connect.mailerlite.com/api/groups"},"summary":"List all groups","description":"If you want to list all of your groups, you can send this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Groups"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#create-a-group","api_endpoint":"https://connect.mailerlite.com/api/groups"},"summary":"Create a group","description":"If you want to create a group, you can send this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum length of 255 characters","required":true}}},"example":{"name":""}}}}}},"/groups/{group_id}":{"put":{"tags":["Groups"],"parameters":[{"name":"group_id","in":"path","description":"Group id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#update-a-group","api_endpoint":"https://connect.mailerlite.com/api/groups/{group_id}"},"summary":"Update a group","description":"If you want to update a group you can send this `PUT` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum length of 255 characters","required":true}}},"example":{"name":""}}}}},"delete":{"tags":["Groups"],"parameters":[{"name":"group_id","in":"path","description":"Group id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#delete-group","api_endpoint":"https://connect.mailerlite.com/api/groups/{group_id}"},"summary":"Delete group","description":"If you want to delete a group, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/groups/{group_id}/subscribers":{"get":{"tags":["Groups"],"parameters":[{"name":"group_id","in":"path","description":"Group id","required":true,"schema":{"type":"string","example":""}},{"name":"filter[status]","in":"query","description":"Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk. Defaults to active.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Number of subscribers to return per page. Defaults to 50. Maximum is 1000.","required":false,"schema":{"type":"number","example":""}},{"name":"cursor","in":"query","description":"Defaults to first page. Use `meta.next_cursor` or `meta.prev_cursor` from response to navigate.","required":false,"schema":{"type":"string","example":""}},{"name":"include","in":"query","description":"Additional resources to include in the response. Currently, only `groups` is supported.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#get-subscribers-belonging-to-a-group","api_endpoint":"https://connect.mailerlite.com/api/groups/{group_id}/subscribers"},"summary":"Get subscribers belonging to a group","description":"If you want to get all subscribers belonging to a group, send this `GET` request","security":[{"bearerAuth":[]}]}},"/subscribers/{subscriber_id}/groups/{group_id}":{"post":{"tags":["Groups"],"parameters":[{"name":"subscriber_id","in":"path","description":"Must be an existing subscriber id","required":true,"schema":{"type":"number","example":""}},{"name":"group_id","in":"path","description":"Must be an existing group id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#assign-subscriber-to-a-group","api_endpoint":"https://connect.mailerlite.com/api/subscribers/{subscriber_id}/groups/{group_id}"},"summary":"Assign subscriber to a group","description":"If you want to assign an existing subscriber to a group, send this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Groups"],"parameters":[{"name":"subscriber_id","in":"path","description":"Must be an existing subscriber id","required":true,"schema":{"type":"number","example":""}},{"name":"group_id","in":"path","description":"Must be an existing group id on the account","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#unassign-subscriber-from-a-group","api_endpoint":"https://connect.mailerlite.com/api/subscribers/{subscriber_id}/groups/{group_id}"},"summary":"Unassign subscriber from a group","description":"If you want to unassign an existing subscriber from a group, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/groups/{group_id}/import-subscribers":{"post":{"tags":["Groups"],"parameters":[{"name":"group_id","in":"path","description":"Group id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/groups/#import-bulk-subscribers-to-group","api_endpoint":"https://connect.mailerlite.com/api/groups/{group_id}/import-subscribers"},"summary":"Import bulk subscribers to group","description":"Use this request to bulk import subscribers to a group. The response is a URL to check the import's progress.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subscribers":{"type":"array","description":"Must be an array of subscribers objects.","required":true,"items":{"type":"object","properties":{"email":{"type":"string","description":"Valid email address as per RFC 2821","required":true},"fields":{"type":"object","description":"Object keys must correspond to default or custom field name. Values can only be added this way and will not be removed by omission."}}}}}},"example":{"subscribers":[]}}}}}},"/segments":{"get":{"tags":["Segments"],"parameters":[{"name":"limit","in":"query","description":"An account can have at most a 250 segments","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Count starts from 1","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/segments/#list-all-segments","api_endpoint":"https://connect.mailerlite.com/api/segments"},"summary":"List all segments","description":"If you want to list all segments in your account, send this `GET` request","security":[{"bearerAuth":[]}]}},"/segments/{segment_id}/subscribers":{"get":{"tags":["Segments"],"parameters":[{"name":"segment_id","in":"path","description":"Segment id","required":true,"schema":{"type":"string","example":""}},{"name":"filter[status]","in":"query","description":"Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk. Defaults to active.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limit","required":false,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"The last subscriber id, available in meta.last","required":false,"schema":{"type":"number","example":""}},{"name":"cursor","in":"query","description":"Defaults to first page. Cursor value available in response body","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/segments/#get-subscribers-belonging-to-a-segment","api_endpoint":"https://connect.mailerlite.com/api/segments/{segment_id}/subscribers"},"summary":"Get subscribers belonging to a segment","description":"If you want to get all subscribers belonging to a segment, send this `GET` request","security":[{"bearerAuth":[]}]}},"/segments/{segment_id}":{"put":{"tags":["Segments"],"parameters":[{"name":"segment_id","in":"path","description":"Segment id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/segments/#update-segment","api_endpoint":"https://connect.mailerlite.com/api/segments/{segment_id}"},"summary":"Update segment","description":"If you want to update a segment use this `PUT` endpoint","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Maximum length of 255 characters","required":true}}},"example":{"name":""}}}}},"delete":{"tags":["Segments"],"parameters":[{"name":"segment_id","in":"path","description":"Segment id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/segments/#delete-segment","api_endpoint":"https://connect.mailerlite.com/api/segments/{segment_id}"},"summary":"Delete segment","description":"If you wish to delete a segment, use this `DELETE` endpoint","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subscribers":{"get":{"tags":["Subscribers"],"parameters":[{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#fetch-total-subscribers-count","api_endpoint":"https://connect.mailerlite.com/api/subscribers"},"summary":"Fetch total subscribers count","description":"Fetch total subscribers count","security":[{"bearerAuth":[]}]},"post":{"tags":["Subscribers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#createupsert-subscriber","api_endpoint":"https://connect.mailerlite.com/api/subscribers"},"summary":"Create/upsert subscriber","description":"If you want to create or update a subscriber, send this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Valid email address as per RFC 2821","required":true},"fields":{"type":"object","description":"Object keys must correspond to default or custom field name. Values can only be added this way and will not be removed by omission."},"groups":{"type":"array","description":"array must contain existing group ids. Subscriber can only be added to groups this way and will not be removed by omission","items":{"type":"string"}},"status":{"type":"string","description":"Can be one of the following: active, unsubscribed, unconfirmed, bounced, junk"},"subscribed_at":{"type":"string","description":"Must be a valid date in the format `yyyy-MM-dd HH:mm:ss`"},"ip_address":{"type":"string","description":"Must be a valid ip address"},"opted_in_at":{"type":"string","description":"Must be a valid date in the format `yyyy-MM-dd HH:mm:ss`"},"optin_ip":{"type":"string","description":"Must be a valid ip address"},"unsubscribed_at":{"type":"string","description":"Must be a valid date in the format `yyyy-MM-dd HH:mm:ss`"},"resubscribe":{"type":"boolean","description":"Set to true to resubscribe previously unsubscribed subscribers","enum":[true,false]}}},"example":{"email":"","fields":{},"groups":[],"status":"","subscribed_at":"","ip_address":"","opted_in_at":"","optin_ip":"","unsubscribed_at":"","resubscribe":""}}}}}},"/subscribers/{id}":{"put":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#update-a-subscriber","api_endpoint":"https://connect.mailerlite.com/api/subscribers/{id}"},"summary":"Update a subscriber","description":"If you want to update a single subscriber, send this `PUT` request:","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"object","description":"Object keys must correspond to default or custom field name. Values can only be added this way and will not be removed by omission."},"groups":{"type":"array","description":"array containing existing group ids. Subscriber will be removed from unlisted groups","items":{"type":"string"}},"status":{"type":"string","description":"Can be one of the following: active, unsubscribed, unconfirmed, bounced, junk"},"subscribed_at":{"type":"string","description":"Must be a valid date in the format `yyyy-MM-dd HH:mm:ss`"},"ip_address":{"type":"string","description":"Must be a valid ip address"},"opted_in_at":{"type":"string","description":"Must be a valid date in the format `yyyy-MM-dd HH:mm:ss`"},"optin_ip":{"type":"string","description":"Must be a valid ip address"},"unsubscribed_at":{"type":"string","description":"Must be a valid date in the format `yyyy-MM-dd HH:mm:ss`"}}},"example":{"fields":{},"groups":[],"status":"","subscribed_at":"","ip_address":"","opted_in_at":"","optin_ip":"","unsubscribed_at":""}}}}},"get":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"Must provide either valid subscriber id or email","required":true,"schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"Must provide either valid subscriber id or email","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#fetch-a-subscriber","api_endpoint":"https://connect.mailerlite.com/api/subscribers/{id}"},"summary":"Fetch a subscriber","description":"If you want to fetch a subscriber, send this `GET` request","security":[{"bearerAuth":[]}]},"delete":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"Valid subscriber id for the account","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#delete-a-subscriber","api_endpoint":"https://connect.mailerlite.com/api/subscribers/{id}"},"summary":"Delete a subscriber","description":"It will removes the subscriber from your account, but all their information is still kept in case they re-subscribe to your list. If you want to delete a subscriber, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subscribers/{id}/activity-log":{"get":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"Must provide either valid subscriber id","required":true,"schema":{"type":"string","example":""}},{"name":"filter[log_name]","in":"query","description":"Must be one of the possible log_name: campaign_send, automation_email_sent, email_open, link_click, email_bounce, spam_complaint, unsubscribed, email_forward, marketing_preferences_change or preference_center.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Defaults to 100","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Count starts from 1","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#fetch-subscriber-activity","api_endpoint":"https://connect.mailerlite.com/api/subscribers/{id}/activity-log"},"summary":"Fetch subscriber activity","description":"Fetch subscriber activity","security":[{"bearerAuth":[]}]}},"/subscribers/{id}/forget":{"post":{"tags":["Subscribers"],"parameters":[{"name":"id","in":"path","description":"Valid subscriber id for the account","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#forget-a-subscriber","api_endpoint":"https://connect.mailerlite.com/api/subscribers/{id}/forget"},"summary":"Forget a subscriber","description":"It will removes the subscriber from your account and all information will be completely deleted in 30 days. This feature is GDPR compliant.If you want to forget a subscriber, send this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subscribers/import/{import_id}":{"get":{"tags":["Subscribers"],"parameters":[{"name":"import_id","in":"path","description":"Import id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/subscribers/#get-single-import","api_endpoint":"https://connect.mailerlite.com/api/subscribers/import/{import_id}"},"summary":"Get single import","description":"If you want to get a single import report, send this `GET` request","security":[{"bearerAuth":[]}]}},"/timezones":{"get":{"tags":["Timezones"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/timezones/","api_endpoint":"https://connect.mailerlite.com/api/timezones"},"summary":"Timezones","description":"Use this `GET` request to get all available timezones","security":[{"bearerAuth":[]}]}},"/webhooks":{"get":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/webhooks/#list-all-webhooks","api_endpoint":"https://connect.mailerlite.com/api/webhooks"},"summary":"List all webhooks","description":"List all webhooks","security":[{"bearerAuth":[]}]},"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/api/webhooks/#create-a-webhook","api_endpoint":"https://connect.mailerlite.com/api/webhooks"},"summary":"Create a webhook","description":"Create a webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"events":{"type":"array","description":"Must be one of the events described in following table","required":true,"items":{"type":"string"}},"url":{"type":"string","description":"Url","required":true},"enabled":{"type":"boolean","description":"Enabled","enum":[true,false]},"batchable":{"type":"boolean","description":"Required as `true` only for `campaign.open` and `campaign.click` events","enum":[true,false]}}},"example":{"name":"","events":[],"url":"","enabled":"","batchable":""}}}}}},"/webhooks/{webhook_id}":{"get":{"tags":["Webhooks"],"parameters":[{"name":"webhook_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://developers.mailerlite.com/api/webhooks/#get-a-webhook","api_endpoint":"https://connect.mailerlite.com/api/webhooks/{webhook_id}"},"summary":"Get a webhook","description":"Get a webhook","security":[{"bearerAuth":[]}]},"put":{"tags":["Webhooks"],"parameters":[{"name":"webhook_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://developers.mailerlite.com/api/webhooks/#update-a-webhook","api_endpoint":"https://connect.mailerlite.com/api/webhooks/{webhook_id}"},"summary":"Update a webhook","description":"Update a webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"events":{"type":"array","description":"Events","items":{"type":"string"}},"url":{"type":"string","description":"Url"},"enabled":{"type":"boolean","description":"Enabled","enum":[true,false]},"batchable":{"type":"boolean","description":"Required as `true` only for `campaign.open` and `campaign.click` events","enum":[true,false]}}},"example":{"name":"","events":[],"url":"","enabled":"","batchable":""}}}}},"delete":{"tags":["Webhooks"],"parameters":[{"name":"webhook_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://developers.mailerlite.com/api/webhooks/#delete-a-webhook","api_endpoint":"https://connect.mailerlite.com/api/webhooks/{webhook_id}"},"summary":"Delete a webhook","description":"Delete a webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/carts/{cart_id}/items":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"cart_id","in":"path","description":"Must provide valid cart id","required":true,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart-items/#fetch-total-cart-items-count","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts/{cart_id}/items"},"summary":"Fetch total cart items count","description":"If you want to fetch the total cart items count, send this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}},{"name":"cart_id","in":"path","description":"Cart id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart-items/#addupdate-a-cart-item","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts/{cart_id}/items"},"summary":"Add/update a cart item","description":"You can add or update a cart item.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ecommerce_product_id":{"type":"number","description":"The id of the product to add to the cart","required":true},"variant":{"type":"string","description":"The product's variant information."},"quantity":{"type":"number","description":"The products quantity. Defaults to `1`."},"price":{"type":"string","description":"The cart item's price. Defaults to `0`."}}},"example":{"ecommerce_product_id":"","variant":"","quantity":"","price":""}}}}}},"/ecommerce/shops/{shop_id}/carts/{cart_id}/items/{item_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}},{"name":"cart_id","in":"path","description":"Cart id","required":true,"schema":{"type":"string","example":""}},{"name":"item_id","in":"path","description":"Item id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart-items/#addupdate-a-cart-item","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts/{cart_id}/items/{item_id}"},"summary":"Add/update a cart item (PUT /ecommerce/shops/{shop_id}/carts/{cart_id}/items/{item_id})","description":"You can add or update a cart item.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ecommerce_product_id":{"type":"number","description":"The id of the product to add to the cart","required":true},"variant":{"type":"string","description":"The product's variant information."},"quantity":{"type":"number","description":"The products quantity. Defaults to `1`."},"price":{"type":"string","description":"The cart item's price. Defaults to `0`."}}},"example":{"ecommerce_product_id":"","variant":"","quantity":"","price":""}}}}},"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"cart_id","in":"path","description":"Must provide valid cart id","required":true,"schema":{"type":"number","example":""}},{"name":"item_id","in":"path","description":"Must provide valid cart item id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart-items/#fetch-a-cart-item","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts/{cart_id}/items/{item_id}"},"summary":"Fetch a cart item","description":"If you want to create a cart item, send this `GET` request","security":[{"bearerAuth":[]}]},"delete":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"cart_id","in":"path","description":"Must provide valid cart id","required":true,"schema":{"type":"number","example":""}},{"name":"item_id","in":"path","description":"Must provide valid cart item id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart-items/#delete-a-cart-item","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts/{cart_id}/items/{item_id}"},"summary":"Delete a cart item","description":"If you want to delete a cart item, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/carts":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart/#fetch-total-carts-count","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts"},"summary":"Fetch total carts count","description":"If you want to fetch total carts count, send this `GET` request","security":[{"bearerAuth":[]}]}},"/ecommerce/shops/{shop_id}/carts/{cart_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}},{"name":"cart_id","in":"path","description":"Cart id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart/#update-a-cart","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts/{cart_id}"},"summary":"Update a cart","description":"If you want to update a cart, please send this `PUT` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"checkout_url":{"type":"string","description":"The cart's checkout url."},"cart_total":{"type":"string","description":"The cart's total price in the shop's currency. Defaults to `0`."}}},"example":{"checkout_url":"","cart_total":""}}}}},"get":{"tags":["Ecommerce"],"parameters":[{"name":"cart_id","in":"path","description":"Must provide valid cart id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/cart/#fetch-a-cart","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/carts/{cart_id}"},"summary":"Fetch a cart","description":"If you want to fetch a cart, please send this `GET` request","security":[{"bearerAuth":[]}]}},"/ecommerce/shops/{shop_id}/categories/{category_id}/products":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"category_id","in":"path","description":"Must provide category id","required":true,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Defaults to `100`","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Defaults to `1`","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories-products/#get-the-products-of-a-category","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories/{category_id}/products"},"summary":"Get the products of a category","description":"If you want to get the products for a particular shop and a category, send this `GET` request","security":[{"bearerAuth":[]}]}},"/ecommerce/shops/{shop_id}/categories/{category_id}/products/{product_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"category_id","in":"path","description":"Must provide category id","required":true,"schema":{"type":"number","example":""}},{"name":"product_id","in":"path","description":"Must provide product id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories-products/#assign-a-product-to-a-category","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories/{category_id}/products/{product_id}"},"summary":"Assign a product to a category","description":"If you want to assign a product to a category for a given shop, send this `PUT` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"category_id","in":"path","description":"Must provide category id","required":true,"schema":{"type":"number","example":""}},{"name":"product_id","in":"path","description":"Must provide product id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories-products/#unassign-a-product-from-a-category","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories/{category_id}/products/{product_id}"},"summary":"Unassign a product from a category","description":"If you want to unassign a product from a category for a given shop, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/categories":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories/#fetch-total-categories-count","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories"},"summary":"Fetch total categories count","description":"If you want to fetch the count of all categories, send this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories/#createupdate-category","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories"},"summary":"Create/update category","description":"You can create or update the category of the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The category's name","required":true},"exclude_from_automations":{"type":"boolean","description":"If true this category will not trigger any automations. Defaults to `false`","enum":[true,false]}}},"example":{"name":"","exclude_from_automations":""}}}}}},"/ecommerce/shops/{shop_id}/categories/{category_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}},{"name":"category_id","in":"path","description":"Category id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories/#createupdate-category","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories/{category_id}"},"summary":"Create/update category (PUT /ecommerce/shops/{shop_id}/categories/{category_id})","description":"You can create or update the category of the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The category's name","required":true},"exclude_from_automations":{"type":"boolean","description":"If true this category will not trigger any automations. Defaults to `false`","enum":[true,false]}}},"example":{"name":"","exclude_from_automations":""}}}}},"get":{"tags":["Ecommerce"],"parameters":[{"name":"category_id","in":"path","description":"Must provide valid category id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories/#fetch-a-category","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories/{category_id}"},"summary":"Fetch a category","description":"If you want to fetch a category for a given shop, send this `GET` request","security":[{"bearerAuth":[]}]},"delete":{"tags":["Ecommerce"],"parameters":[{"name":"category_id","in":"path","description":"Must provide valid category id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/categories/#delete-a-category","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories/{category_id}"},"summary":"Delete a category","description":"If you want to delete a category for the given shop, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/customers":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/customers/#fetch-total-customers-count","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/customers"},"summary":"Fetch total customers count","description":"If you want to fetch total customers count for the given shop, send this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/customers/#createupdate-customer","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/customers"},"summary":"Create/update customer","description":"You can create or update a customer for the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Customer's email address","required":true},"accepts_marketing":{"type":"boolean","description":"True if the customer accepts marketing emails, false otherwise","enum":[true,false]},"total_spent":{"type":"string","description":"The total amount the customer has spent in the shop."},"create_subscriber":{"type":"boolean","description":"If set, a subscriber will be created for the customer.","enum":[true,false]}}},"example":{"email":"","accepts_marketing":"","total_spent":"","create_subscriber":""}}}}}},"/ecommerce/shops/{shop_id}/customers/{customer_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}},{"name":"customer_id","in":"path","description":"Customer id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/customers/#createupdate-customer","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/customers/{customer_id}"},"summary":"Create/update customer (PUT /ecommerce/shops/{shop_id}/customers/{customer_id})","description":"You can create or update a customer for the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Customer's email address","required":true},"accepts_marketing":{"type":"boolean","description":"True if the customer accepts marketing emails, false otherwise","enum":[true,false]},"total_spent":{"type":"string","description":"The total amount the customer has spent in the shop."},"create_subscriber":{"type":"boolean","description":"If set, a subscriber will be created for the customer.","enum":[true,false]}}},"example":{"email":"","accepts_marketing":"","total_spent":"","create_subscriber":""}}}}},"get":{"tags":["Ecommerce"],"parameters":[{"name":"customer_id","in":"path","description":"Must provide valid customer id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/customers/#fetch-a-customer","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/customers/{customer_id}"},"summary":"Fetch a customer","description":"If you want to fetch a customer for the given shop, send this `GET` request","security":[{"bearerAuth":[]}]},"delete":{"tags":["Ecommerce"],"parameters":[{"name":"customer_id","in":"path","description":"Must provide valid customer id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/customers/#delete-a-customer","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/customers/{customer_id}"},"summary":"Delete a customer","description":"If you want to delete a customer for the given shop, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/categories/import":{"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/import/#categories-import","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/categories/import"},"summary":"Categories import","description":"If you want to import multiple categories for the given shop, send this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/products/import":{"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/import/#products-import","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/products/import"},"summary":"Products import","description":"If you want to import products for the given shop, use this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/orders/import":{"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/import/#orders-import","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/orders/import"},"summary":"Orders import","description":"If you want to import orders including customers, carts and cart items for the given shop, send this `POST` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/orders":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/orders/#fetch-total-orders-count","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/orders"},"summary":"Fetch total orders count","description":"If you want to fetch total orders count for the given shop, send this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/orders/#createupdate-order","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/orders"},"summary":"Create/update order","description":"You can create or update an order for the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"customer":{"type":"array","description":"The customer information. Check the respective ecommerce customer api documentation.","required":true,"items":{"type":"string"}},"cart":{"type":"array","description":"The order cart. Check the respective ecommerce cart api documentation.","required":true,"items":{"type":"string"}},"status":{"type":"string","description":"The order's status. Allowed values: `pending`, `complete`. Defaults to `pending`."},"total_price":{"type":"string","description":"The order's total price. Defaults to `0`."}}},"example":{"customer":[],"cart":[],"status":"","total_price":""}}}}}},"/ecommerce/shops/{shop_id}/orders/{order_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}},{"name":"order_id","in":"path","description":"Order id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/orders/#createupdate-order","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/orders/{order_id}"},"summary":"Create/update order (PUT /ecommerce/shops/{shop_id}/orders/{order_id})","description":"You can create or update an order for the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"customer":{"type":"array","description":"The customer information. Check the respective ecommerce customer api documentation.","required":true,"items":{"type":"string"}},"cart":{"type":"array","description":"The order cart. Check the respective ecommerce cart api documentation.","required":true,"items":{"type":"string"}},"status":{"type":"string","description":"The order's status. Allowed values: `pending`, `complete`. Defaults to `pending`."},"total_price":{"type":"string","description":"The order's total price. Defaults to `0`."}}},"example":{"customer":[],"cart":[],"status":"","total_price":""}}}}},"get":{"tags":["Ecommerce"],"parameters":[{"name":"order_id","in":"path","description":"Must provide valid order id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/orders/#fetch-an-order","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/orders/{order_id}"},"summary":"Fetch an order","description":"If you want to fetch an order for the given shop, send this `GET` request","security":[{"bearerAuth":[]}]},"delete":{"tags":["Ecommerce"],"parameters":[{"name":"order_id","in":"path","description":"Must provide valid order id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/orders/#delete-an-order","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/orders/{order_id}"},"summary":"Delete an order","description":"If you want to delete an order, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops/{shop_id}/products":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/products/#fetch-total-products-count","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/products"},"summary":"Fetch total products count","description":"If you want to fetch the total products count for the given shop, send this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/products/#createupdate-product","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/products"},"summary":"Create/update product","description":"You can create or update a product for the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The product's name","required":true},"price":{"type":"string","description":"The product's price in the shop's currency. Defaults to `0`."},"exclude_from_automations":{"type":"boolean","description":"If true this product will not trigger any automations. Defaults to `false`","enum":[true,false]},"url":{"type":"string","description":"The products url."},"image":{"type":"string","description":"The products main image url."},"short_description":{"type":"string","description":"The product's short description. Max `255` characters. HTML tags are automatically removed"},"description":{"type":"string","description":"The product's description. HTML tags are automatically removed."}}},"example":{"name":"","price":"","exclude_from_automations":"","url":"","image":"","short_description":"","description":""}}}}}},"/ecommerce/shops/{shop_id}/products/{product_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}},{"name":"product_id","in":"path","description":"Product id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/products/#createupdate-product","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/products/{product_id}"},"summary":"Create/update product (PUT /ecommerce/shops/{shop_id}/products/{product_id})","description":"You can create or update a product for the given shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The product's name","required":true},"price":{"type":"string","description":"The product's price in the shop's currency. Defaults to `0`."},"exclude_from_automations":{"type":"boolean","description":"If true this product will not trigger any automations. Defaults to `false`","enum":[true,false]},"url":{"type":"string","description":"The products url."},"image":{"type":"string","description":"The products main image url."},"short_description":{"type":"string","description":"The product's short description. Max `255` characters. HTML tags are automatically removed"},"description":{"type":"string","description":"The product's description. HTML tags are automatically removed."}}},"example":{"name":"","price":"","exclude_from_automations":"","url":"","image":"","short_description":"","description":""}}}}},"get":{"tags":["Ecommerce"],"parameters":[{"name":"product_id","in":"path","description":"Must provide valid product id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/products/#fetch-a-product","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/products/{product_id}"},"summary":"Fetch a product","description":"If you want to fetch a product for the given shop, send this `GET` request","security":[{"bearerAuth":[]}]},"delete":{"tags":["Ecommerce"],"parameters":[{"name":"product_id","in":"path","description":"Must provide valid product id","required":true,"schema":{"type":"number","example":""}},{"name":"shop_id","in":"path","description":"Must provide valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/products/#delete-a-product","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}/products/{product_id}"},"summary":"Delete a product","description":"If you want to delete a product for the given shop, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ecommerce/shops":{"get":{"tags":["Ecommerce"],"parameters":[{"name":"limit","in":"query","description":"Value must be 0","required":true,"schema":{"type":"number","example":"","items":{"type":"string","enum":[0]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/shops/#fetch-total-shops-count","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops"},"summary":"Fetch total shops count","description":"If you want to fetch total shops count, send this `GET` request","security":[{"bearerAuth":[]}]},"post":{"tags":["Ecommerce"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/shops/#createupdate-shop","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops"},"summary":"Create/update shop","description":"You can create or update a shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Shop name","required":true},"url":{"type":"string","description":"Shop URL address","required":true},"currency":{"type":"string","description":"ISO 4217 currency code that the shop uses.","required":true},"platform":{"type":"string","description":"The platform of the shop (e.g. shopify)"},"group_id":{"type":"number","description":"The id of the group that the shop's subscribers are automatically added to."},"enable_popups":{"type":"boolean","description":"Enables popups to the shop (the shop must have the universal script added to it). Defaults to `false`.","enum":[true,false]},"enabled":{"type":"boolean","description":"Enable/disable the ecommerce functionality for the shop. Defaults to `false`.","enum":[true,false]},"access_data":{"type":"string","description":"Platform specific information for the platform to access the shop (e.g. shopify access token or woocommerce keys). Shouldn't be needed for third party users."}}},"example":{"name":"","url":"","currency":"","platform":"","group_id":"","enable_popups":"","enabled":"","access_data":""}}}}}},"/ecommerce/shops/{shop_id}":{"put":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Shop id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/shops/#createupdate-shop","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}"},"summary":"Create/update shop (PUT /ecommerce/shops/{shop_id})","description":"You can create or update a shop.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Shop name","required":true},"url":{"type":"string","description":"Shop URL address","required":true},"currency":{"type":"string","description":"ISO 4217 currency code that the shop uses.","required":true},"platform":{"type":"string","description":"The platform of the shop (e.g. shopify)"},"group_id":{"type":"number","description":"The id of the group that the shop's subscribers are automatically added to."},"enable_popups":{"type":"boolean","description":"Enables popups to the shop (the shop must have the universal script added to it). Defaults to `false`.","enum":[true,false]},"enabled":{"type":"boolean","description":"Enable/disable the ecommerce functionality for the shop. Defaults to `false`.","enum":[true,false]},"access_data":{"type":"string","description":"Platform specific information for the platform to access the shop (e.g. shopify access token or woocommerce keys). Shouldn't be needed for third party users."}}},"example":{"name":"","url":"","currency":"","platform":"","group_id":"","enable_popups":"","enabled":"","access_data":""}}}}},"get":{"tags":["Ecommerce"],"parameters":[{"name":"shop_id","in":"path","description":"Must provide either valid shop id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/shops/#fetch-a-shop","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{shop_id}"},"summary":"Fetch a shop","description":"Fetch a shop","security":[{"bearerAuth":[]}]}},"/ecommerce/shops/{id}":{"delete":{"tags":["Ecommerce"],"parameters":[{"name":"id","in":"path","description":"Valid shop id for the account","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.mailerlite.com/ecommerce/shops/#delete-a-shop","api_endpoint":"https://connect.mailerlite.com/api/ecommerce/shops/{id}"},"summary":"Delete a shop","description":"If you want to delete a shop, send this `DELETE` request","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}