Skip to content
Changelog

Report a bug

MailerLite integration: operations for AI agents

MailerLite connects to Type.com as an integration. This page lists the 97 operations documented for Claude and Codex in Type.com: 44 read, 27 write, 26 destructive.

About MailerLite

MailerLite is an email marketing service that offers tools for creating and managing email campaigns, automating workflows, and building landing pages.

Categories: Marketing & Social

How to connect MailerLite to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

97 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

97 operations listed.

automations

  • Read

    List all automations

    If you want to get all of your automations use this GET request Documented Parameter: Type: Required: Limitations: filter[enabled]: boolean: no: Must be one of the following: true (for active) and false (for inactive). Defaults to return all automations; filter[name]: string: no: Must be a string; filter[group]: string: no: Must be a valid group id. Returns all automations that use the group in their trigger configuration; page: integer: no: Defaults to 1; limit: integer: no: Defaults to 10. Bounded field names from malformed successful-response example (not a schema or verified payload): data, data[].id, data[].name, data[].enabled, data[].trigger_data, data[].trigger_data.track_ecommerce, data[].trigger_data.repeatable, data[].trigger_data.valid, data[].steps, data[].steps[].id, data[].steps[].type, data[].steps[].parent_id, data[].steps[].unit, data[].steps[].complete, data[].steps[].created_at, data[].steps[].updated_at, data[].steps[].value, data[].steps[].description, data[].triggers, data[].triggers[].id, data[].triggers[].type, data[].triggers[].group_ids, data[].triggers[].groups, data[].triggers[].groups[].id, data[].triggers[].groups[].name, data[].triggers[].groups[].url, data[].triggers[].exclude_group_ids, data[].triggers[].excluded_groups, data[].triggers[].broken, data[].complete, data[].broken, data[].warnings, data[].emails_count, data[].first_email_screenshot_url, data[].stats, data[].stats.completed_subscribers_count, data[].stats.subscribers_in_queue_count, data[].stats.bounce_rate, data[].stats.bounce_rate.float, data[].stats.bounce_rate.string, data[].stats.click_to_open_rate, data[].stats.click_to_open_rate.float, data[].stats.click_to_open_rate.string, data[].stats.sent, data[].stats.opens_count, data[].stats.unique_opens_count, data[].stats.open_rate, data[].stats.open_rate.float, data[].stats.open_rate.string, data[].stats.clicks_count, data[].stats.unique_clicks_count, data[].stats.click_rate, data[].stats.click_rate.float, data[].stats.click_rate.string, data[].stats.unsubscribes_count, data[].stats.unsubscribe_rate, data[].stats.unsubscribe_rate.float, data[].stats.unsubscribe_rate.string, data[].stats.spam_count, data[].stats.spam_rate, data[].stats.spam_rate.float, data[].stats.spam_rate.string, data[].stats.hard_bounces_count, data[].stats.hard_bounce_rate, data[].stats.hard_bounce_rate.float, data[].stats.hard_bounce_rate.string, data[].stats.soft_bounces_count, data[].stats.soft_bounce_rate, data[].stats.soft_bounce_rate.float, data[].stats.soft_bounce_rate.string, data[].created_at, data[].has_banned_content, data[].qualified_subscribers_count, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total, aggregations, aggregations.sum.

    GET /api/automations

  • Read

    Get an automation

    If you want to fetch a specific automation you can use this GET endpoint When providing an invalid automation id Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.enabled, data.trigger_data, data.trigger_data.track_ecommerce, data.trigger_data.repeatable, data.trigger_data.valid, data.steps, data.steps[].id, data.steps[].type, data.steps[].parent_id, data.steps[].unit, data.steps[].complete, data.steps[].created_at, data.steps[].updated_at, data.steps[].value, data.steps[].description, data.triggers, data.triggers[].id, data.triggers[].type, data.triggers[].group_ids, data.triggers[].groups, data.triggers[].groups[].id, data.triggers[].groups[].name, data.triggers[].groups[].url, data.triggers[].exclude_group_ids, data.triggers[].excluded_groups, data.triggers[].broken, data.complete, data.broken, data.warnings, data.emails_count, data.first_email_screenshot_url, data.stats, data.stats.completed_subscribers_count, data.stats.subscribers_in_queue_count, data.stats.bounce_rate, data.stats.bounce_rate.float, data.stats.bounce_rate.string, data.stats.click_to_open_rate, data.stats.click_to_open_rate.float, data.stats.click_to_open_rate.string, data.stats.sent, data.stats.opens_count, data.stats.unique_opens_count, data.stats.open_rate, data.stats.open_rate.float, data.stats.open_rate.string, data.stats.clicks_count, data.stats.unique_clicks_count, data.stats.click_rate, data.stats.click_rate.float, data.stats.click_rate.string, data.stats.unsubscribes_count, data.stats.unsubscribe_rate, data.stats.unsubscribe_rate.float, data.stats.unsubscribe_rate.string, data.stats.spam_count, data.stats.spam_rate, data.stats.spam_rate.float, data.stats.spam_rate.string, data.stats.hard_bounces_count, data.stats.hard_bounce_rate, data.stats.hard_bounce_rate.float, data.stats.hard_bounce_rate.string, data.stats.soft_bounces_count, data.stats.soft_bounce_rate, data.stats.soft_bounce_rate.float, data.stats.soft_bounce_rate.string, data.created_at, data.has_banned_content, data.qualified_subscribers_count.

    GET /api/automations/{automation_id}

  • Read

    Get the subscriber activity for an automation

    If you want to fetch the subscriber activity for an automation use this GET request When providing an invalid automation id Documented Parameter: Type: Required: Limitations: filter[status]: string: yes: Must be one of the following: completed , active , canceled , failed; filter[date_from]: date: no: Must be in the format Y-m-d . Relevant for statuses: completed , canceled , failed; filter[date_to]: date: no: Must be in the format Y-m-d . Relevant for statuses: completed , canceled , failed; filter[scheduled_from]: date: no: Must be in the format Y-m-d . Relevant for active status; filter[scheduled_to]: date: no: Must be in the format Y-m-d . Relevant for active status; filter[search]: string: no: Must be a subscriber email; page: integer: no: Defaults to 1; limit: integer: no: Defaults to 10. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].status, data[].date, data[].reason, data[].reason_description, data[].stepRuns, data[].stepRuns[].id, data[].stepRuns[].step_id, data[].stepRuns[].description, data[].stepRuns[].scheduled_for, data[].nextStep, data[].nextStep.id, data[].nextStep.type, data[].nextStep.parent_id, data[].nextStep.complete, data[].nextStep.broken, data[].nextStep.yes_step_id, data[].nextStep.no_step_id, data[].nextStep.matching_type, data[].nextStep.conditions, data[].nextStep.conditions[].type, data[].nextStep.conditions[].field_id, data[].nextStep.conditions[].action, data[].nextStep.conditions[].action_value, data[].nextStep.conditions[].field, data[].nextStep.conditions[].field.id, data[].nextStep.conditions[].field.name, data[].nextStep.conditions[].field.type, data[].nextStep.created_at, data[].nextStep.updated_at, data[].nextStep.description, data[].currentStep, data[].currentStep.id, data[].currentStep.type, data[].currentStep.parent_id, data[].currentStep.name, data[].currentStep.subject, data[].currentStep.from, data[].currentStep.from_name, data[].currentStep.email_id, data[].currentStep.email, data[].currentStep.email.id, data[].currentStep.email.account_id, data[].currentStep.email.emailable_id, data[].currentStep.email.emailable_type, data[].currentStep.email.type, data[].currentStep.email.from, data[].currentStep.email.from_name, data[].currentStep.email.name, data[].currentStep.email.subject, data[].currentStep.email.plain_text, data[].currentStep.email.screenshot_url, data[].currentStep.email.preview_url, data[].currentStep.email.created_at, data[].currentStep.email.updated_at, data[].currentStep.email.is_designed, data[].currentStep.email.language_id, data[].currentStep.email.is_winner, data[].currentStep.email.stats, data[].currentStep.email.stats.sent, data[].currentStep.email.stats.opens_count, data[].currentStep.email.stats.unique_opens_count, data[].currentStep.email.stats.open_rate, data[].currentStep.email.stats.open_rate.float, data[].currentStep.email.stats.open_rate.string, data[].currentStep.email.stats.clicks_count, data[].currentStep.email.stats.unique_clicks_count, data[].currentStep.email.stats.click_rate, data[].currentStep.email.stats.click_rate.float, data[].currentStep.email.stats.click_rate.string, data[].currentStep.email.stats.unsubscribes_count, data[].currentStep.email.stats.unsubscribe_rate, data[].currentStep.email.stats.unsubscribe_rate.float, data[].currentStep.email.stats.unsubscribe_rate.string, data[].currentStep.email.stats.spam_count, data[].currentStep.email.stats.spam_rate, data[].currentStep.email.stats.spam_rate.float, data[].currentStep.email.stats.spam_rate.string, data[].currentStep.email.stats.hard_bounces_count, data[].currentStep.email.stats.hard_bounce_rate, data[].currentStep.email.stats.hard_bounce_rate.float, data[].currentStep.email.stats.hard_bounce_rate.string, data[].currentStep.email.stats.soft_bounces_count, data[].currentStep.email.stats.soft_bounce_rate, data[].currentStep.email.stats.soft_bounce_rate.float, data[].currentStep.email.stats.soft_bounce_rate.string, data[].currentStep.email.stats.forwards_count, data[].currentStep.email.send_after, data[].currentStep.email.track_opens, data[].currentStep.language_id, data[].currentStep.complete, data[].currentStep.created_at, data[].currentStep.updated_at, data[].currentStep.track_opens, data[].currentStep.google_analytics, data[].currentStep.tracking_was_disabled, data[].currentStep.description, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/automations/{automation_id}/activity

  • Write

    Create draft automation

    If you want to create draft automations use this POST request Documented Parameter: Type: Required: Limitations: name: string: yes: Must be a string. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.enabled, data.trigger_data, data.trigger_data.track_ecommerce, data.warnings, data.stats, data.stats.completed_subscribers_count, data.stats.subscribers_in_queue_count, data.stats.bounce_rate, data.stats.bounce_rate.float, data.stats.bounce_rate.string, data.stats.click_to_open_rate, data.stats.click_to_open_rate.float, data.stats.click_to_open_rate.string, data.stats.sent, data.stats.opens_count, data.stats.unique_opens_count, data.stats.open_rate, data.stats.open_rate.float, data.stats.open_rate.string, data.stats.clicks_count, data.stats.unique_clicks_count, data.stats.click_rate, data.stats.click_rate.float, data.stats.click_rate.string, data.stats.unsubscribes_count, data.stats.unsubscribe_rate, data.stats.unsubscribe_rate.float, data.stats.unsubscribe_rate.string, data.stats.spam_count, data.stats.spam_rate, data.stats.spam_rate.float, data.stats.spam_rate.string, data.stats.hard_bounces_count, data.stats.hard_bounce_rate, data.stats.hard_bounce_rate.float, data.stats.hard_bounce_rate.string, data.stats.soft_bounces_count, data.stats.soft_bounce_rate, data.stats.soft_bounce_rate.float, data.stats.soft_bounce_rate.string, data.stats.forward_rate, data.stats.forward_rate.float, data.stats.forward_rate.string, data.stats.social_interactions_count, data.stats.social_interaction_rate, data.stats.social_interaction_rate.float, data.stats.social_interaction_rate.string, data.created_at, data.has_banned_content, data.steps.

    POST /api/automations

  • Destructive

    Delete automation

    If you want to delete automation use this DELETE request

    DELETE /api/automations/{automation_id}

batching

  • Destructive

    Batching

    The batch endpoint can be used to make multiple request to our api in a single call A maximum of 50 requests can be performed in a single batch The order of response objects is the same as the order in which they were sent Webhooks are not yet supported in batch requests When a batch request consists entirely of POST api/subscribers requests (subscriber upserts), the API automatically processes them as a bulk import internally. This import path is subject to a separate 5 requests per minute rate limit, in addition to the global API rate limit. When the import rate limit is exceeded, the batch will return a 429 response directly: If invalid data has been passed If one of the batched requests has failed the whole batch will still be processed and the payload for the relevant errored batch will return the error Documented Parameter: Type: Required: Limitations: requests: array: required: Array of objects containing required method and path properties and optional body; requests.*.method: string: required: The method type of the intended request: GET, POST, PUT, DELETE, PATCH; requests.*.path: string: required: The relative path of api endpoint. Must start with api/; requests.*.body: object: optional: Objects containing properties for the body of the request. Documented JSON-example fields (not a formal required-field schema): message. Documented JSON-example fields (not a formal required-field schema): total, successful, failed, responses, responses[].code, responses[].body, responses[].body.data, responses[].body.data[].id, responses[].body.data[].name, responses[].body.data[].key, responses[].body.data[].type. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.requests.0.method, errors.requests.0.path. Documented JSON-example fields (not a formal required-field schema): total, successful, failed, responses, responses[].code, responses[].body, responses[].body.message, responses[].body.errors, responses[].body.errors.requests.0.method.

    POST /api/batch

campaign-languages

  • Read

    Campaign languages

    Use this GET request to get a list of all campaign languages available Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].shortcode, data[].iso639, data[].name, data[].direction.

    GET /api/campaigns/languages

campaigns

  • Read

    Campaign list

    If you want to get a list of all of your campaigns based on status or type use this GET request Documented Parameter: Type: Required: Limitations: filter[status]: string: no: Must be one of the following: sent, draft, ready. Defaults to ready; filter[type]: string: no: Must be one of the following: regular, ab, resend, rss. Defaults to return all; limit: integer: no: Defaults to 25; page: integer: no: Defaults to 1. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].account_id, data[].name, data[].type, data[].status, data[].missing_data, data[].settings, data[].settings.track_opens, data[].settings.use_google_analytics, data[].settings.ecommerce_tracking, data[].filter, data[].filter[][].operator, data[].filter[][].args, data[].filter_for_humans, data[].delivery_schedule, data[].language_id, data[].created_at, data[].updated_at, data[].scheduled_for, data[].queued_at, data[].started_at, data[].finished_at, data[].stopped_at, data[].default_email_id, data[].emails, data[].emails[].id, data[].emails[].account_id, data[].emails[].emailable_id, data[].emails[].emailable_type, data[].emails[].type, data[].emails[].from, data[].emails[].from_name, data[].emails[].reply_to, data[].emails[].name, data[].emails[].subject, data[].emails[].plain_text, data[].emails[].screenshot_url, data[].emails[].preview_url, data[].emails[].created_at, data[].emails[].updated_at, data[].emails[].is_designed, data[].emails[].language_id, data[].emails[].is_winner, data[].emails[].stats, data[].emails[].stats.sent, data[].emails[].stats.opens_count, data[].emails[].stats.unique_opens_count, data[].emails[].stats.open_rate, data[].emails[].stats.open_rate.float, data[].emails[].stats.open_rate.string, data[].emails[].stats.clicks_count, data[].emails[].stats.unique_clicks_count, data[].emails[].stats.click_rate, data[].emails[].stats.click_rate.float, data[].emails[].stats.click_rate.string, data[].emails[].stats.unsubscribes_count, data[].emails[].stats.unsubscribe_rate, data[].emails[].stats.unsubscribe_rate.float, data[].emails[].stats.unsubscribe_rate.string, data[].emails[].stats.spam_count, data[].emails[].stats.spam_rate, data[].emails[].stats.spam_rate.float, data[].emails[].stats.spam_rate.string, data[].emails[].stats.hard_bounces_count, data[].emails[].stats.hard_bounce_rate, data[].emails[].stats.hard_bounce_rate.float, data[].emails[].stats.hard_bounce_rate.string, data[].emails[].stats.soft_bounces_count, data[].emails[].stats.soft_bounce_rate, data[].emails[].stats.soft_bounce_rate.float, data[].emails[].stats.soft_bounce_rate.string, data[].emails[].stats.forwards_count, data[].emails[].send_after, data[].emails[].track_opens, data[].used_in_automations, data[].type_for_humans, data[].stats, data[].stats.sent, data[].stats.opens_count, data[].stats.unique_opens_count, data[].stats.open_rate, data[].stats.open_rate.float, data[].stats.open_rate.string, data[].stats.clicks_count, data[].stats.unique_clicks_count, data[].stats.click_rate, data[].stats.click_rate.float, data[].stats.click_rate.string, data[].stats.unsubscribes_count, data[].stats.unsubscribe_rate, data[].stats.unsubscribe_rate.float, data[].stats.unsubscribe_rate.string, data[].stats.spam_count, data[].stats.spam_rate, data[].stats.spam_rate.float, data[].stats.spam_rate.string, data[].stats.hard_bounces_count, data[].stats.hard_bounce_rate, data[].stats.hard_bounce_rate.float, data[].stats.hard_bounce_rate.string, data[].stats.soft_bounces_count, data[].stats.soft_bounce_rate, data[].stats.soft_bounce_rate.float, data[].stats.soft_bounce_rate.string, data[].stats.forwards_count, data[].stats.click_to_open_rate, data[].stats.click_to_open_rate.float, data[].stats.click_to_open_rate.string, data[].is_stopped, data[].has_winner, data[].winner_version_for_human, data[].winner_sending_time_for_humans, data[].winner_selected_manually_at, data[].uses_ecommerce, data[].uses_survey, data[].can_be_scheduled, data[].warnings, data[].initial_created_at, data[].is_currently_sending_out, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total, meta.aggregations, meta.aggregations.sum, meta.aggregations.draft, meta.aggregations.ready, meta.aggregations.sent.

    GET /api/campaigns

  • Read

    Get a campaign

    You can fetch an existing campaign using this GET request When providing an invalid campaign id Documented JSON-example fields (not a formal required-field schema): data, data.id, data.account_id, data.name, data.type, data.status, data.missing_data, data.settings, data.settings.track_opens, data.settings.use_google_analytics, data.settings.ecommerce_tracking, data.filter, data.filter[][].operator, data.filter[][].args, data.filter_for_humans, data.delivery_schedule, data.language_id, data.created_at, data.updated_at, data.scheduled_for, data.queued_at, data.started_at, data.finished_at, data.stopped_at, data.default_email_id, data.emails, data.emails[].id, data.emails[].account_id, data.emails[].emailable_id, data.emails[].emailable_type, data.emails[].type, data.emails[].from, data.emails[].from_name, data.emails[].reply_to, data.emails[].name, data.emails[].subject, data.emails[].plain_text, data.emails[].screenshot_url, data.emails[].preview_url, data.emails[].created_at, data.emails[].updated_at, data.emails[].is_designed, data.emails[].language_id, data.emails[].is_winner, data.emails[].stats, data.emails[].stats.sent, data.emails[].stats.opens_count, data.emails[].stats.unique_opens_count, data.emails[].stats.open_rate, data.emails[].stats.open_rate.float, data.emails[].stats.open_rate.string, data.emails[].stats.clicks_count, data.emails[].stats.unique_clicks_count, data.emails[].stats.click_rate, data.emails[].stats.click_rate.float, data.emails[].stats.click_rate.string, data.emails[].stats.unsubscribes_count, data.emails[].stats.unsubscribe_rate, data.emails[].stats.unsubscribe_rate.float, data.emails[].stats.unsubscribe_rate.string, data.emails[].stats.spam_count, data.emails[].stats.spam_rate, data.emails[].stats.spam_rate.float, data.emails[].stats.spam_rate.string, data.emails[].stats.hard_bounces_count, data.emails[].stats.hard_bounce_rate, data.emails[].stats.hard_bounce_rate.float, data.emails[].stats.hard_bounce_rate.string, data.emails[].stats.soft_bounces_count, data.emails[].stats.soft_bounce_rate, data.emails[].stats.soft_bounce_rate.float, data.emails[].stats.soft_bounce_rate.string, data.emails[].stats.forwards_count, data.emails[].send_after, data.emails[].track_opens, data.used_in_automations, data.type_for_humans, data.is_stopped, data.has_winner, data.winner_version_for_human, data.winner_sending_time_for_humans, data.winner_selected_manually_at, data.uses_ecommerce, data.uses_survey, data.can_be_scheduled, data.warnings, data.initial_created_at, data.is_currently_sending_out.

    GET /api/campaigns/{campaign_id}

  • Read

    Get subscribers' activity of a sent campaign

    If you want to get the subscribers' activity of a campaign with status sent use this GET request When providing an invalid campaign id Documented Parameter: Type: Required: Limitations: filter[type]: string: no: Must be one of following: opened , unopened , clicked , unsubscribed , forwarded , hardbounced , softbounced , junk . Defaults to returning all recipients; filter[search]: string: no: Must be a subscriber email; limit: integer: no: Must be one of the following: 10, 25, 50, 100 . Defaults to 50; sort: string: no: Must be one of the following: id , updated_at , clicks_count , opens_count . Defaults to id; page: integer: no: Defaults to 1; include: string: no: Additional resources to include in the response. Currently subscriber and subscriber.groups are supported.. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].opens_count, data[].clicks_count, data[].subscriber, data[].subscriber.id, data[].subscriber.email, data[].subscriber.status, data[].subscriber.source, data[].subscriber.sent, data[].subscriber.opens_count, data[].subscriber.clicks_count, data[].subscriber.open_rate, data[].subscriber.click_rate, data[].subscriber.ip_address, data[].subscriber.subscribed_at, data[].subscriber.unsubscribed_at, data[].subscriber.created_at, data[].subscriber.updated_at, data[].subscriber.fields, data[].subscriber.fields.name, data[].subscriber.fields.last_name, data[].subscriber.fields.company, data[].subscriber.fields.country, data[].subscriber.fields.city, data[].subscriber.fields.phone, data[].subscriber.fields.state, data[].subscriber.fields.zip, data[].subscriber.opted_in_at, data[].subscriber.optin_ip, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total, meta.aggregations, meta.aggregations.sum, meta.aggregations.opened, meta.aggregations.unopened, meta.aggregations.clicked, meta.aggregations.unsubscribed, meta.aggregations.forwarded, meta.aggregations.hardbounced, meta.aggregations.softbounced, meta.aggregations.junk. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.limit.

    GET /api/campaigns/{campaign_id}/reports/subscriber-activity

  • Read

    Get campaign e-commerce stats

    If you want to get the orders and revenue a campaign earned in a shop, use this GET request best_performing_email is only set when the campaign has more than one email, for example an A/B test. When providing an invalid campaign or shop id Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must be a valid e-commerce shop id. Documented JSON-example fields (not a formal required-field schema): data, data.ecommerce, data.ecommerce.orders_count, data.ecommerce.revenue, data.ecommerce.average_order_value, data.ecommerce.conversion_rate, data.best_performing_email.

    GET /api/campaigns/{campaign_id}/reports/ecommerce

  • Read

    Get campaign e-commerce orders

    If you want to list the orders a campaign earned in a shop, use this GET request When providing an invalid campaign or shop id Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must be a valid e-commerce shop id; limit: integer: no: Defaults to 10; page: integer: no: Defaults to 1. Documented JSON-example fields (not a formal required-field schema): data, data[].subscriber, data[].subscriber.email, data[].subscriber.id, data[].total, data[].updated_at, data[].order, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/campaigns/{campaign_id}/reports/ecommerce/orders

  • Write

    Create a campaign

    You can create a campaign using this POST request When campaign request has missing parameters Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum string length of 255 characters; language_id: integer: no: Used to define the language in the unsubscribe template. Must be a valid language id. Defaults to english; type: string: yes: Must be one of the following: regular , ab , resend , multivariate . Types resend and multivariate are only available for accounts on growing or advanced plans; emails: array: yes: 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; emails.*.subject: string: yes, unless multivariate campaign: Maximum string length of 255 characters; emails.*.from_name: string: yes, unless multivariate campaign: Maximum string length of 255 characters; emails.*.from: string: yes, unless multivariate campaign: Must be a valid email address that has been already verified on MailerLite; emails.*.reply_to: string: no: Must be a valid reply_to email address that has been already verified on MailerLite; emails.*.content: string: no: 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: array: no: Must contain valid group ids belonging to the account; segments: array: no: Must contain valid segment ids belonging to the account. If both groups and segments are provided, only segments are used; ab_settings: object: only if type is ab: All items of the array are required; ab_settings[test_type]: string: only if type is ab: Must be one of the following: subject , sender , sending_time; ab_settings[select_winner_by]: string: only if type is ab and test type is not sending_time: Must be one of the following: o (for opens), c (for clicks); ab_settings[after_time_amount]: integer: only if type is ab and test type is not sending_time: Defines the amount of wait time for the ab testing; ab_settings[after_time_unit]: string: only if type is ab and test type is not sending_time: Defines the unit of the wait time. Must be one of the following: h (for hours) or d (for days); ab_settings[test_split]: integer: only if type is ab: Must be between 5 and 25 for test types subject and sender and 100 for sending_time test type; ab_settings[b_value]: object: only if type is ab and test type is not sending_time: Must contain the items for the b version of the campaign; ab_settings[b_value][subject]: string: only if ab test type is subject: Maximum string length of 255 characters; ab_settings[b_value][from_name]: string: only if ab test type is sender: Maximum string length of 255 characters; ab_settings[b_value][from]: string: only if ab test type is sender: Must be a valid email address that has been already verified on MailerLite; resend_settings: object: only if type is resend: All items of the array are required; resend_settings[test_type]: string: only if type is resend: Must be one of the following: subject; resend_settings[select_winner_by]: string: only if type is resend: 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); resend_settings[b_value]: object: only if type is resend: Must contain the items for the auto resend of the campaign; resend_setings[b_value][subject]: string: only if type is resend: Maximum string length of 255 characters; multivariate_settings: object: only if type is multivariate: All items of the array are required; multivariate_settings[test_variants]: object: only if type is multivariate: Must contain all 4 test variant options: subject, sender, content and sending_time, however the total amount of email combinations must not exceed 8; multivariate_settings[test_variants][subject]: array: only if type is multivariate: Must contain an array of subject variants. Must contain at least 1; multivariate_settings[test_variants][subject.*]: string: only if type is multivariate: Maximum string length of 255 characters; multivarite_settings[test_variants][sender]: array: only if type is multivariate: Must contain an array of sender variants. Must contain at least 1; multivariate_settings[test_variants][sender.*]: object: only if type is multivariate: Must contain from and from_name; multivariate_settings[test_variants][sender.*.from]: string: only if type is multivariate: Must be a valid email address that has been already verified on MailerLite; multivariate_settings[test_variants][sender.*.from_name]: string: only if type is multivariate: Maximum string length of 255 characters; multivarite_settings[test_variants][content]: integer: only if type is multivariate: Must be a number between 1 and 8; multivarite_settings[test_variants][sending_time]: integer: only if type is multivariate: Must be a number between 1 and 8; multivarite_settings[select_winner_by]: string: only if type is multivariate and test type is not sending_time: Must be one of the following: o (for opens), c (for clicks); multivarite_settings[after_time_amount]: integer: only if type is multivariate and test type is not sending_time: Defines the amount of wait time for the ab testing; multivarite_settings[after_time_unit]: string: only if type is multivariate and test type is not sending_time: Defines the unit of the wait time. Must be one of the following: h (for hours) or d (for days); multivarite_settings[test_split]: integer: only if type is multivariate: Must be between 10 and 50 when sending time is not tested and 100 when sending time is tested; settings: object: no: Object containing campaign configuration options such as ecommerce tracking; settings[ecommerce_tracking]: bool: no: If campaign content contains ecommerce shop URLs, ecommerce link tracking will be enabled when set to true. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.account_id, data.name, data.type, data.status, data.missing_data, data.settings, data.settings.track_opens, data.settings.use_google_analytics, data.settings.ecommerce_tracking, data.filter, data.filter[][].operator, data.filter[][].args, data.filter_for_humans, data.delivery_schedule, data.language_id, data.created_at, data.updated_at, data.scheduled_for, data.queued_at, data.started_at, data.finished_at, data.stopped_at, data.default_email_id, data.emails, data.emails[].id, data.emails[].account_id, data.emails[].emailable_id, data.emails[].emailable_type, data.emails[].type, data.emails[].from, data.emails[].from_name, data.emails[].reply_to, data.emails[].name, data.emails[].subject, data.emails[].plain_text, data.emails[].screenshot_url, data.emails[].preview_url, data.emails[].created_at, data.emails[].updated_at, data.emails[].is_designed, data.emails[].language_id, data.emails[].is_winner, data.emails[].stats, data.emails[].stats.sent, data.emails[].stats.opens_count, data.emails[].stats.unique_opens_count, data.emails[].stats.open_rate, data.emails[].stats.open_rate.float, data.emails[].stats.open_rate.string, data.emails[].stats.clicks_count, data.emails[].stats.unique_clicks_count, data.emails[].stats.click_rate, data.emails[].stats.click_rate.float, data.emails[].stats.click_rate.string, data.emails[].stats.unsubscribes_count, data.emails[].stats.unsubscribe_rate, data.emails[].stats.unsubscribe_rate.float, data.emails[].stats.unsubscribe_rate.string, data.emails[].stats.spam_count, data.emails[].stats.spam_rate, data.emails[].stats.spam_rate.float, data.emails[].stats.spam_rate.string, data.emails[].stats.hard_bounces_count, data.emails[].stats.hard_bounce_rate, data.emails[].stats.hard_bounce_rate.float, data.emails[].stats.hard_bounce_rate.string, data.emails[].stats.soft_bounces_count, data.emails[].stats.soft_bounce_rate, data.emails[].stats.soft_bounce_rate.float, data.emails[].stats.soft_bounce_rate.string, data.emails[].stats.forwards_count, data.emails[].send_after, data.emails[].track_opens, data.used_in_automations, data.type_for_humans, data.is_stopped, data.has_winner, data.winner_version_for_human, data.winner_sending_time_for_humans, data.winner_selected_manually_at, data.uses_ecommerce, data.uses_survey, data.can_be_scheduled, data.warnings, data.initial_created_at, data.is_currently_sending_out. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.type.

    POST /api/campaigns

  • Write

    Update campaign

    If you want to update a campaign that is currently with draft status, use this PUT request When trying to update a campaign that is not with status draft When campaign request has missing parameters When providing an invalid campaign id Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum string length of 255 characters; language_id: integer: no: Used to define the language in the unsubscribe template. Must be a valid language id. Defaults to english; emails: array: yes: Must contain 1 email object item; emails.*.subject: string: yes: Maximum string length of 255 characters; emails.*.from_name: string: yes: Maximum string length of 255 characters; emails.*. from: string: yes: Must be a valid email address that has been already verified on MailerLite; emails.*.content: string: no: 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: array: no: Must contain valid group ids belonging to the account; segments: array: no: Must contain valid segment ids belonging to the account. If both groups and segments are provided, only segments are used; ab_settings: object: only if type is ab: All items of the array are required; ab_settings[test_type]: string: only if type is ab: Must be one of the following: subject , sender , sending_time; ab_settings[select_winner_by]: string: only if type is ab and test type is not sending_time: Must be one of the following: o (for opens), c (for clicks); ab_settings[after_time_amount]: integer: only if type is ab and test type is not sending_time: Defines the amount of wait time for the ab testing; ab_settings[after_time_unit]: string: only if type is ab and test type is not sending_time: Defines the unit of the wait time. Must be one of the following: h (for hours) or d (for days); ab_settings[test_split]: integer: only if type is ab: Must be between 5 and 25 for test types subject and sender and 100 for sending_time test type; ab_settings[b_value]: object: only if type is ab and test type is not sending_time: Must contain the items for the b version of the campaign; ab_settings[b_value][subject]: string: only if ab test type is subject: Maximum string length of 255 characters; ab_settings[b_value][from_name]: string: only if ab test type is sender: Maximum string length of 255 characters; ab_settings[b_value][from]: string: only if ab test type is sender: Must be a valid email address that has been already verified on MailerLite; resend_settings: object: only if type is resend: All items of the array are required; resend_settings[test_type]: string: only if type is resend: Must be one of the following: subject; resend_settings[select_winner_by]: string: only if type is resend: 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); resend_settings[b_value]: object: only if type is resend: Must contain the items for the auto resend of the campaign; resend_setings[b_value][subject]: string: only if type is resend: Maximum string length of 255 characters. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.account_id, data.name, data.type, data.status, data.missing_data, data.settings, data.settings.track_opens, data.settings.use_google_analytics, data.settings.ecommerce_tracking, data.filter, data.filter[][].operator, data.filter[][].args, data.filter_for_humans, data.delivery_schedule, data.language_id, data.created_at, data.updated_at, data.scheduled_for, data.queued_at, data.started_at, data.finished_at, data.stopped_at, data.default_email_id, data.emails, data.emails[].id, data.emails[].account_id, data.emails[].emailable_id, data.emails[].emailable_type, data.emails[].type, data.emails[].from, data.emails[].from_name, data.emails[].name, data.emails[].reply_to, data.emails[].subject, data.emails[].plain_text, data.emails[].screenshot_url, data.emails[].preview_url, data.emails[].created_at, data.emails[].updated_at, data.emails[].is_designed, data.emails[].language_id, data.emails[].is_winner, data.emails[].stats, data.emails[].stats.sent, data.emails[].stats.opens_count, data.emails[].stats.unique_opens_count, data.emails[].stats.open_rate, data.emails[].stats.open_rate.float, data.emails[].stats.open_rate.string, data.emails[].stats.clicks_count, data.emails[].stats.unique_clicks_count, data.emails[].stats.click_rate, data.emails[].stats.click_rate.float, data.emails[].stats.click_rate.string, data.emails[].stats.unsubscribes_count, data.emails[].stats.unsubscribe_rate, data.emails[].stats.unsubscribe_rate.float, data.emails[].stats.unsubscribe_rate.string, data.emails[].stats.spam_count, data.emails[].stats.spam_rate, data.emails[].stats.spam_rate.float, data.emails[].stats.spam_rate.string, data.emails[].stats.hard_bounces_count, data.emails[].stats.hard_bounce_rate, data.emails[].stats.hard_bounce_rate.float, data.emails[].stats.hard_bounce_rate.string, data.emails[].stats.soft_bounces_count, data.emails[].stats.soft_bounce_rate, data.emails[].stats.soft_bounce_rate.float, data.emails[].stats.soft_bounce_rate.string, data.emails[].stats.forwards_count, data.emails[].send_after, data.emails[].track_opens, data.used_in_automations, data.type_for_humans, data.is_stopped, data.has_winner, data.winner_version_for_human, data.winner_sending_time_for_humans, data.winner_selected_manually_at, data.uses_ecommerce, data.uses_survey, data.can_be_scheduled, data.warnings, data.initial_created_at, data.is_currently_sending_out. Documented JSON-example fields (not a formal required-field schema): . Documented JSON-example fields (not a formal required-field schema): message, errors, errors.name.

    PUT /api/campaigns/{campaign_id}

  • Write

    Schedule a campaign

    If you want to schedule or send immediately a campaign, use this POST request When campaign settings are not complete When campaign with given ID has not been found for the account Documented Parameter: Type: Required: Limitations: delivery: string: yes unless campaign type is rss: Must be one of the following: instant, scheduled, timezone_based, smart_sending; schedule[date]: string: only for scheduled and smart_sending delivery type: Must be a date in the future. Campaign must not be of type AB test with sending time test type; schedule[hours]: string: only for scheduled or timezone based delivery types: Must be a valid hour in HH format. Campaign must not be of type AB test with sending time test type; schedule[minutes]: string: only for scheduled or timezone based delivery types: Must be a valid minute in ii format. Campaign must not be of type AB test with sending time test type; schedule[timezone_id]: integer: no: 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[delivery]: string: only for campaign of type auto resend: Must be Must be one of the following: day, scheduled; resend[date]: string: only for campaign of type auto resend: Must be a date in the future; resend[hours]: string: only for campaign of type auto resend: Must be a valid hour in HH format; resend[minutes]: string: only for campaign of type auto resend: Must be a valid minute in ii format; resend[timezone_id]: integer: no: Must be a valid timezone id, defaults to the account's timezone id; sending_time_test_schedule: array: yes if campaign is of type AB test with sending time test type: Must constain 2 sending times; sending_time_test_schedule.*.date: string: yes if campaign is of type AB test with sending time test type: Must be a date in the future; sending_time_test_schedule.*.hours: string: yes if campaign is of type AB test with sending time test type: Must be a valid hour in HH format.; sending_time_test_schedule.*.minutes: string: yes if campaign is of type AB test with sending time test type: Must be a valid minute in ii format.; sending_time_test_schedule.*.timezone_id: string: yes if campaign is of type AB test with sending time test type: Must be a valid timezone id, defaults to the account's timezone id.. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.account_id, data.name, data.type, data.status, data.missing_data, data.settings, data.settings.track_opens, data.settings.use_google_analytics, data.settings.ecommerce_tracking, data.filter, data.filter[][].operator, data.filter[][].args, data.filter_for_humans, data.delivery_schedule, data.language_id, data.created_at, data.updated_at, data.scheduled_for, data.queued_at, data.started_at, data.finished_at, data.stopped_at, data.default_email_id, data.emails, data.emails[].id, data.emails[].account_id, data.emails[].emailable_id, data.emails[].emailable_type, data.emails[].type, data.emails[].from, data.emails[].from_name, data.emails[].name, data.emails[].reply_to, data.emails[].subject, data.emails[].plain_text, data.emails[].screenshot_url, data.emails[].preview_url, data.emails[].created_at, data.emails[].updated_at, data.emails[].is_designed, data.emails[].language_id, data.emails[].is_winner, data.emails[].stats, data.emails[].stats.sent, data.emails[].stats.opens_count, data.emails[].stats.unique_opens_count, data.emails[].stats.open_rate, data.emails[].stats.open_rate.float, data.emails[].stats.open_rate.string, data.emails[].stats.clicks_count, data.emails[].stats.unique_clicks_count, data.emails[].stats.click_rate, data.emails[].stats.click_rate.float, data.emails[].stats.click_rate.string, data.emails[].stats.unsubscribes_count, data.emails[].stats.unsubscribe_rate, data.emails[].stats.unsubscribe_rate.float, data.emails[].stats.unsubscribe_rate.string, data.emails[].stats.spam_count, data.emails[].stats.spam_rate, data.emails[].stats.spam_rate.float, data.emails[].stats.spam_rate.string, data.emails[].stats.hard_bounces_count, data.emails[].stats.hard_bounce_rate, data.emails[].stats.hard_bounce_rate.float, data.emails[].stats.hard_bounce_rate.string, data.emails[].stats.soft_bounces_count, data.emails[].stats.soft_bounce_rate, data.emails[].stats.soft_bounce_rate.float, data.emails[].stats.soft_bounce_rate.string, data.emails[].stats.forwards_count, data.emails[].send_after, data.emails[].track_opens, data.used_in_automations, data.type_for_humans, data.is_stopped, data.has_winner, data.winner_version_for_human, data.winner_sending_time_for_humans, data.winner_selected_manually_at, data.uses_ecommerce, data.uses_survey, data.can_be_scheduled, data.warnings, data.initial_created_at, data.is_currently_sending_out. Documented JSON-example fields (not a formal required-field schema): .

    POST /api/campaigns/{campaign_id}/schedule

  • Destructive

    Cancel a ready campaign

    If you wish to cancel a campaign that is currently in a ready state, use this POST request When trying to cancel a campaign sending that is not in a ready state When campaign with given ID has not been found for the account Documented JSON-example fields (not a formal required-field schema): data, data.id, data.account_id, data.name, data.type, data.status, data.missing_data, data.settings, data.settings.track_opens, data.settings.use_google_analytics, data.settings.ecommerce_tracking, data.filter, data.filter[][].operator, data.filter[][].args, data.filter_for_humans, data.delivery_schedule, data.language_id, data.created_at, data.updated_at, data.scheduled_for, data.queued_at, data.started_at, data.finished_at, data.stopped_at, data.default_email_id, data.emails, data.emails[].id, data.emails[].account_id, data.emails[].emailable_id, data.emails[].emailable_type, data.emails[].type, data.emails[].from, data.emails[].from_name, data.emails[].name, data.emails[].reply_to, data.emails[].subject, data.emails[].plain_text, data.emails[].screenshot_url, data.emails[].preview_url, data.emails[].created_at, data.emails[].updated_at, data.emails[].is_designed, data.emails[].language_id, data.emails[].is_winner, data.emails[].stats, data.emails[].stats.sent, data.emails[].stats.opens_count, data.emails[].stats.unique_opens_count, data.emails[].stats.open_rate, data.emails[].stats.open_rate.float, data.emails[].stats.open_rate.string, data.emails[].stats.clicks_count, data.emails[].stats.unique_clicks_count, data.emails[].stats.click_rate, data.emails[].stats.click_rate.float, data.emails[].stats.click_rate.string, data.emails[].stats.unsubscribes_count, data.emails[].stats.unsubscribe_rate, data.emails[].stats.unsubscribe_rate.float, data.emails[].stats.unsubscribe_rate.string, data.emails[].stats.spam_count, data.emails[].stats.spam_rate, data.emails[].stats.spam_rate.float, data.emails[].stats.spam_rate.string, data.emails[].stats.hard_bounces_count, data.emails[].stats.hard_bounce_rate, data.emails[].stats.hard_bounce_rate.float, data.emails[].stats.hard_bounce_rate.string, data.emails[].stats.soft_bounces_count, data.emails[].stats.soft_bounce_rate, data.emails[].stats.soft_bounce_rate.float, data.emails[].stats.soft_bounce_rate.string, data.emails[].stats.forwards_count, data.emails[].send_after, data.emails[].track_opens, data.used_in_automations, data.type_for_humans, data.is_stopped, data.has_winner, data.winner_version_for_human, data.winner_sending_time_for_humans, data.winner_selected_manually_at, data.uses_ecommerce, data.uses_survey, data.can_be_scheduled, data.warnings, data.initial_created_at, data.is_currently_sending_out.

    POST /api/campaigns/{campaign_id}/cancel

  • Destructive

    Delete a campaign

    If you want to delete a campaign, use this DELETE request

    DELETE /api/campaigns/{campaign_id}

fields

  • Read

    List all fields

    If you want to list all of your fields, use this GET endpoint Documented Parameter: Type: Required: Limitations: limit: integer: no: An account can have at most a 100 groups; page: integer: no: Count starts from 1; filter[keyword]: string: no: Returns partial matches; filter[type]: string: no: Can be one of the following: text, number or date; sort: string: no: Can be one of: name , type , Defaults to ascending order; prepend - , e.g. -name for descending order.. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].key, data[].type, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/fields

  • Write

    Create a field

    If you want to create a field that can be assigned to subscribers, use this POST request If invalid data has been passed Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum length of 255 characters; type: string: yes: Can be text, number or date. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.key, data.type. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.type.

    POST /api/fields

  • Write

    Update a field

    If you want to update a field, use this PUT request If invalid data has been passed Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum length of 255 characters. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.key, data.type. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.type.

    PUT /api/fields/{field_id}

  • Destructive

    Delete a field

    If you want to delete a field, use this DELETE request

    DELETE /api/fields/{field_id}

forms

  • Read

    List all forms

    If you want to list all forms in your account, send this GET request Type value is required and can be popup , embedded , or promotion . Documented Parameter: Type: Required: Limitations: limit: integer: no: ; page: integer: no: Count starts from 1; filter[name]: string: no: Returns partial matches; sort: string: no: 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.. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].type, data[].slug, data[].name, data[].created_at, data[].conversions_count, data[].opens_count, data[].conversion_rate, data[].conversion_rate.float, data[].conversion_rate.string, data[].settings, data[].last_registration_at, data[].active, data[].is_broken, data[].has_content, data[].can, data[].can.update, data[].used_in_automations, data[].warnings, data[].double_optin, data[].screenshot_url, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total, meta.aggregations, meta.aggregations.popup, meta.aggregations.embedded, meta.aggregations.promotion.

    GET /api/forms/{type}

  • Read

    Get a form

    If you want to fetch a specific form you can use this GET request When the form id is invalid Documented JSON-example fields (not a formal required-field schema): data, data.id, data.type, data.slug, data.name, data.created_at, data.conversions_count, data.opens_count, data.conversion_rate, data.conversion_rate.float, data.conversion_rate.string, data.settings, data.last_registration_at, data.active, data.is_broken, data.has_content, data.can, data.can.update, data.used_in_automations, data.warnings, data.double_optin, data.screenshot_url.

    GET /api/forms/{form_id}

  • Read

    Get subscribers who signed up to a specific form

    If you want to fetch all the subscribers who signed up to a specific form use this GET request When the form id is invalid Documented Parameter: Type: Required: Limitations: filter[status]: string: no: Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk. Defaults to active.; limit: integer: no: Defaults to 25; cursor: string: no: Defaults to first page. Cursor value available in response body. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].email, data[].status, data[].source, data[].sent, data[].opens_count, data[].clicks_count, data[].open_rate, data[].click_rate, data[].ip_address, data[].subscribed_at, data[].unsubscribed_at, data[].created_at, data[].updated_at, data[].fields, data[].fields.city, data[].fields.company, data[].fields.country, data[].fields.last_name, data[].fields.name, data[].fields.phone, data[].fields.state, data[].fields.z_i_p, data[].groups, data[].opted_in_at, data[].optin_ip, links, links.first, links.last, links.prev, links.next, meta, meta.path, meta.per_page, meta.next_cursor, meta.prev_cursor.

    GET /api/forms/{form_id}/subscribers

  • Write

    Update a form

    If you want to update a form use this PUT request The id must a valid form id that belongs to the account When the form id is invalid If invalid data has been passed Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum length of 255 characters. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.type, data.slug, data.name, data.created_at, data.conversions_count, data.opens_count, data.conversion_rate, data.conversion_rate.float, data.conversion_rate.string, data.settings, data.last_registration_at, data.active, data.is_broken, data.has_content, data.can, data.can.update, data.used_in_automations, data.warnings, data.double_optin, data.screenshot_url. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.name.

    PUT /api/forms/{form_id}

  • Destructive

    Delete a form

    Use this DELETE request to delete a form The id must a valid form id that belongs to the account. When the form id is invalid

    DELETE /api/forms/{form_id}

groups

  • Read

    List all groups

    If you want to list all of your groups, you can send this GET request Documented Parameter: Type: Required: Limitations: limit: integer: no: An account can have at most a 1000 groups; page: integer: no: Count starts from 1; filter[name]: string: no: Returns partial matches; sort: string: no: Can be one of: name , total , open_rate , click_rate , created_at . Defaults to ascending order; prepend - , e.g. -total for descending order.. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].active_count, data[].sent_count, data[].opens_count, data[].open_rate, data[].open_rate.float, data[].open_rate.string, data[].clicks_count, data[].click_rate, data[].click_rate.float, data[].click_rate.string, data[].unsubscribed_count, data[].unconfirmed_count, data[].bounced_count, data[].junk_count, data[].created_at, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/groups

  • Read

    Get subscribers belonging to a group

    If you want to get all subscribers belonging to a group, send this GET request Documented Parameter: Type: Required: Limitations: filter[status]: string: no: Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk. Defaults to active.; limit: integer: no: Number of subscribers to return per page. Defaults to 50. Maximum is 1000.; cursor: string: no: Defaults to first page. Use meta.next_cursor or meta.prev_cursor from response to navigate.; include: string: no: Additional resources to include in the response. Currently, only groups is supported.. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].email, data[].status, data[].source, data[].sent, data[].opens_count, data[].clicks_count, data[].open_rate, data[].click_rate, data[].ip_address, data[].subscribed_at, data[].unsubscribed_at, data[].created_at, data[].updated_at, data[].fields, data[].fields.city, data[].fields.company, data[].fields.country, data[].fields.last_name, data[].fields.name, data[].fields.phone, data[].fields.state, data[].fields.z_i_p, data[].opted_in_at, data[].optin_ip, links, links.first, links.last, links.prev, links.next, meta, meta.path, meta.per_page, meta.next_cursor, meta.prev_cursor.

    GET /api/groups/{group_id}/subscribers

  • Write

    Create a group

    If you want to create a group, you can send this POST request Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum length of 255 characters. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.active_count, data.sent_count, data.opens_count, data.open_rate, data.open_rate.float, data.open_rate.string, data.clicks_count, data.click_rate, data.click_rate.float, data.click_rate.string, data.unsubscribed_count, data.unconfirmed_count, data.bounced_count, data.junk_count, data.created_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.name.

    POST /api/groups

  • Write

    Update a group

    If you want to update a group you can send this PUT request Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum length of 255 characters. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.active_count, data.sent_count, data.opens_count, data.open_rate, data.open_rate.float, data.open_rate.string, data.clicks_count, data.click_rate, data.click_rate.float, data.click_rate.string, data.unsubscribed_count, data.unconfirmed_count, data.bounced_count, data.junk_count, data.created_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.name.

    PUT /api/groups/{group_id}

  • Write

    Assign subscriber to a group

    If you want to assign an existing subscriber to a group, send this POST request Documented Parameter: Type: Required: Limitations: subscriber_id: integer: yes: Must be an existing subscriber id; group_id: integer: yes: Must be an existing group id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.active_count, data.sent_count, data.opens_count, data.open_rate, data.open_rate.float, data.open_rate.string, data.clicks_count, data.click_rate, data.click_rate.float, data.click_rate.string, data.unsubscribed_count, data.unconfirmed_count, data.bounced_count, data.junk_count, data.created_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.id.

    POST /api/subscribers/{subscriber_id}/groups/{group_id}

  • Write

    Import bulk subscribers to group

    Use this request to bulk import subscribers to a group. The response is a URL to check the import's progress. Rate limit This endpoint is limited to 5 requests per minute per API token. The response shows a maximum of 5 sample subscribers in arrays. Documented Parameter: Type: Required: Limitations: subscribers: array: yes: Must be an array of subscribers objects.; subscribers.*.email: string: yes: Valid email address as per RFC 2821; subscribers.*.fields: object: no: Object keys must correspond to default or custom field name. Values can only be added this way and will not be removed by omission.. Documented JSON-example fields (not a formal required-field schema): import_progress_url. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.account_id, data.total, data.processed, data.imported, data.updated, data.errored, data.percent, data.done, data.invalid, data.invalid_count, data.mistyped, data.mistyped_count, data.changed, data.changed_count, data.unchanged, data.unchanged_count, data.unsubscribed, data.unsubscribed_count, data.role_based, data.role_based_count, data.suspicious_format, data.suspicious_format_count, data.duplicate, data.duplicate_count, data.banned_import_emails_count, data.updated_at, data.undone_at, data.stopped_at, data.undo_started_at, data.finished_at. Documented JSON-example fields (not a formal required-field schema): message.

    POST /api/groups/{group_id}/import-subscribers

  • Destructive

    Delete group

    If you want to delete a group, send this DELETE request

    DELETE /api/groups/{group_id}

  • Destructive

    Unassign subscriber from a group

    If you want to unassign an existing subscriber from a group, send this DELETE request Documented Parameter: Type: Required: Limitations: subscriber_id: integer: yes: Must be an existing subscriber id; group_id: integer: yes: Must be an existing group id on the account. Documented JSON-example fields (not a formal required-field schema): message.

    DELETE /api/subscribers/{subscriber_id}/groups/{group_id}

segments

  • Read

    List all segments

    If you want to list all segments in your account, send this GET request Documented Parameter: Type: Required: Limitations: limit: integer: no: An account can have at most a 250 segments; page: integer: no: Count starts from 1. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].total, data[].open_rate, data[].open_rate.float, data[].open_rate.string, data[].click_rate, data[].click_rate.float, data[].click_rate.string, data[].created_at, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/segments

  • Read

    Get subscribers belonging to a segment

    If you want to get all subscribers belonging to a segment, send this GET request Documented Parameter: Type: Required: Limitations: filter[status]: string: no: Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk. Defaults to active.; limit: integer: no: ; after: integer: no: The last subscriber id, available in meta.last; cursor: string: no: Defaults to first page. Cursor value available in response body. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].email, data[].status, data[].source, data[].sent, data[].opens_count, data[].clicks_count, data[].open_rate, data[].click_rate, data[].ip_address, data[].subscribed_at, data[].unsubscribed_at, data[].created_at, data[].updated_at, data[].fields, data[].fields.city, data[].fields.company, data[].fields.country, data[].fields.last_name, data[].fields.name, data[].fields.phone, data[].fields.state, data[].fields.z_i_p, data[].groups, data[].opted_in_at, data[].optin_ip, links, links.first, links.last, links.prev, links.next, meta, meta.path, meta.per_page, meta.next_cursor, meta.prev_cursor.

    GET /api/segments/{segment_id}/subscribers

  • Write

    Update segment

    If you want to update a segment use this PUT endpoint The id must a valid segment id that belongs to the account When the segment id is invalid If invalid data has been passed Documented Parameter: Type: Required: Limitations: name: string: yes: Maximum length of 255 characters. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.total, data.open_rate, data.open_rate.float, data.open_rate.string, data.click_rate, data.click_rate.float, data.click_rate.string, data.created_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.type.

    PUT /api/segments/{segment_id}

  • Destructive

    Delete segment

    If you wish to delete a segment, use this DELETE endpoint The id must a valid segment id that belongs to the account When the segment id is invalid

    DELETE /api/segments/{segment_id}

subscribers

  • Read

    List all subscribers

    If you want to list all of your subscribers, send this GET request Documented Parameter: Type: Required: Limitations: filter[status]: string: no: Must be one of the possible statuses: active, unsubscribed, unconfirmed, bounced or junk.; limit: integer: no: Defaults to 25; cursor: string: no: Defaults to first page. Cursor value available in response body; include: string: no: Additional resources to include in the response. Currently, only groups is supported.. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].email, data[].status, data[].source, data[].sent, data[].opens_count, data[].clicks_count, data[].open_rate, data[].click_rate, data[].ip_address, data[].subscribed_at, data[].unsubscribed_at, data[].created_at, data[].updated_at, data[].fields, data[].fields.city, data[].fields.company, data[].fields.country, data[].fields.last_name, data[].fields.name, data[].fields.phone, data[].fields.state, data[].fields.z_i_p, data[].opted_in_at, data[].optin_ip, links, links.first, links.last, links.prev, links.next, meta, meta.path, meta.per_page, meta.next_cursor, meta.prev_cursor. Documented Parameter: Type: Required: Limitations: limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/subscribers

  • Read

    Fetch a subscriber

    If you want to fetch a subscriber, send this GET request If subscriber exists: If the subscriber cannot be found: Documented Parameter: Type: Required: Limitations: email: string: no: Must provide either valid subscriber id or email; id: string: no: Must provide either valid subscriber id or email. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.email, data.status, data.source, data.sent, data.opens_count, data.clicks_count, data.open_rate, data.click_rate, data.ip_address, data.subscribed_at, data.unsubscribed_at, data.created_at, data.updated_at, data.fields, data.fields.city, data.fields.company, data.fields.country, data.fields.last_name, data.fields.name, data.fields.phone, data.fields.state, data.fields.z_i_p, data.groups, data.opted_in_at, data.optin_ip.

    GET /api/subscribers/{subscriber_id_or_email}

  • Read

    Fetch subscriber activity

    Documented Parameter: Type: Required: Limitations: id: string: yes: Must provide either valid subscriber id; filter[log_name]: string: no: 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.; limit: integer: no: Defaults to 100; page: integer: no: Count starts from 1. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].log_name, data[].subject_id, data[].subject_type, data[].properties, data[].properties.group_name, data[].properties.group_id, data[].created_at, data[].updated_at.

    GET /api/subscribers/{id}/activity-log

  • Read

    Get single import

    If you want to get a single import report, send this GET request Documented JSON-example fields (not a formal required-field schema): data, data.id, data.total, data.processed, data.imported, data.updated, data.errored, data.percent, data.done, data.file_path, data.invalid, data.invalid_count, data.mistyped, data.mistyped_count, data.changed, data.changed_count, data.unchanged, data.unchanged[].id, data.unchanged[].email, data.unchanged_count, data.unsubscribed, data.unsubscribed_count, data.role_based, data.role_based_count, data.banned_import_emails_count, data.match_route, data.source_label, data.updated_at, data.undone_at, data.stopped_at, data.undo_started_at, data.finished_at.

    GET /api/subscribers/import/{import_id}

  • Read

    Fetch subscriber e-commerce stats

    If you want to get the completed orders a subscriber placed in a shop from your emails, use this GET request When providing an invalid subscriber or shop id Documented Parameter: Type: Required: Limitations: id: string: yes: Must be a valid subscriber id; shop_id: integer: yes: Must be a valid e-commerce shop id. Documented JSON-example fields (not a formal required-field schema): data, data.ecommerce, data.ecommerce.orders_count, data.ecommerce.revenue, data.ecommerce.average_order_value, data.ecommerce.conversion_rate.

    GET /api/subscribers/{id}/reports/ecommerce

  • Read

    Fetch subscriber e-commerce orders

    If you want to list the completed orders a subscriber placed in a shop from your emails, use this GET request email is the email that earned the order, in the same format as the emails in Get a campaign . When providing an invalid subscriber or shop id Documented Parameter: Type: Required: Limitations: id: string: yes: Must be a valid subscriber id; shop_id: integer: yes: Must be a valid e-commerce shop id; limit: integer: no: Defaults to 10; page: integer: no: Defaults to 1. Documented JSON-example fields (not a formal required-field schema): data, data[].subscriber, data[].subscriber.email, data[].subscriber.id, data[].total, data[].updated_at, data[].order, data[].email, data[].email.id, data[].email.emailable_type, data[].email.subject, data[].email...., links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/subscribers/{id}/reports/ecommerce/orders

  • Destructive

    Create/upsert subscriber

    If you want to create or update a subscriber, send this POST request If a subscriber already exists, it will be updated with new values. This is non-destructive operation, so omitting fields or groups will not remove them from subscriber. If the subscriber was created: If the subscriber with specified email was already in the mailing list: Documented Parameter: Type: Required: Limitations: email: string: yes: Valid email address as per RFC 2821; fields: object: no: 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: array: no: array must contain existing group ids. Subscriber can only be added to groups this way and will not be removed by omission; status: string: no: Can be one of the following: active, unsubscribed, unconfirmed, bounced, junk; subscribed_at: string: no: Must be a valid date in the format yyyy-MM-dd HH:mm:ss; ip_address: string: no: Must be a valid ip address; opted_in_at: string: no: Must be a valid date in the format yyyy-MM-dd HH:mm:ss; optin_ip: string: no: Must be a valid ip address; unsubscribed_at: string: no: Must be a valid date in the format yyyy-MM-dd HH:mm:ss; resubscribe: bool: no: Set to true to resubscribe previously unsubscribed subscribers. Documented JSON-example fields (not a formal required-field schema): email, fields, fields.name, fields.last_name, groups. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.email, data.status, data.source, data.sent, data.opens_count, data.clicks_count, data.open_rate, data.click_rate, data.ip_address, data.subscribed_at, data.unsubscribed_at, data.created_at, data.updated_at, data.fields, data.fields.city, data.fields.company, data.fields.country, data.fields.last_name, data.fields.name, data.fields.phone, data.fields.state, data.fields.z_i_p, data.groups, data.opted_in_at, data.optin_ip. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.email.

    POST /api/subscribers

  • Destructive

    Update a subscriber

    If you want to update a single subscriber, send this PUT request: If a subscriber already exists, their information will be updated. However, please note that if the subscriber’s status is unsubscribed, bounced, or marked as junk, you will not be able to reactivate them due to abuse prevention measures. In such cases, the subscriber can only be reactivated through the app, a form, or a landing page. Documented Parameter: Type: Required: Limitations: fields: object: no: 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: array: no: array containing existing group ids. Subscriber will be removed from unlisted groups; status: string: no: Can be one of the following: active, unsubscribed, unconfirmed, bounced, junk; subscribed_at: string: no: Must be a valid date in the format yyyy-MM-dd HH:mm:ss; ip_address: string: no: Must be a valid ip address; opted_in_at: string: no: Must be a valid date in the format yyyy-MM-dd HH:mm:ss; optin_ip: string: no: Must be a valid ip address; unsubscribed_at: string: no: Must be a valid date in the format yyyy-MM-dd HH:mm:ss. Documented JSON-example fields (not a formal required-field schema): fields, fields.name, fields.last_name, groups. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.email, data.status, data.source, data.sent, data.opens_count, data.clicks_count, data.open_rate, data.click_rate, data.ip_address, data.subscribed_at, data.unsubscribed_at, data.created_at, data.updated_at, data.fields, data.fields.city, data.fields.company, data.fields.country, data.fields.last_name, data.fields.name, data.fields.phone, data.fields.state, data.fields.z_i_p, data.groups, data.opted_in_at, data.optin_ip. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.email.

    PUT /api/subscribers/{id}

  • Destructive

    Delete a subscriber

    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 Documented Parameter: Type: Required: Limitations: id: string: yes: Valid subscriber id for the account.

    DELETE /api/subscribers/{id}

  • Destructive

    Forget a subscriber

    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 Documented Parameter: Type: Required: Limitations: id: string: yes: Valid subscriber id for the account. Documented JSON-example fields (not a formal required-field schema): message, data, data.id, data.email, data.status, data.source, data.sent, data.opens_count, data.clicks_count, data.open_rate, data.click_rate, data.ip_address, data.subscribed_at, data.unsubscribed_at, data.created_at, data.updated_at, data.deleted_at, data.forget_at, data.fields, data.fields.name, data.fields.last_name, data.fields.company, data.fields.country, data.fields.city, data.fields.phone, data.fields.state, data.fields.zip, data.groups, data.groups[].id, data.groups[].name, data.groups[].active_count, data.groups[].sent_count, data.groups[].opens_count, data.groups[].open_rate, data.groups[].open_rate.float, data.groups[].open_rate.string, data.groups[].clicks_count, data.groups[].click_rate, data.groups[].click_rate.float, data.groups[].click_rate.string, data.groups[].unsubscribed_count, data.groups[].unconfirmed_count, data.groups[].bounced_count, data.groups[].junk_count, data.groups[].created_at, data.groups[].processing, data.groups[].used_in_forms, data.groups[].used_in_sites, data.location, data.location.id, data.location.title, data.location.country_name, data.location.continent_name, data.location.state_name, data.location.time_zone, data.opted_in_at, data.optin_ip, data.email_changed_at.

    POST /api/subscribers/{id}/forget

timezones

  • Read

    Timezones

    Use this GET request to get all available timezones Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].name_for_humans, data[].offset_name, data[].offset.

    GET /api/timezones

webhooks

  • Read

    List all webhooks

    Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].url, data[].events, data[].enabled, data[].secret, data[].created_at, data[].updated_at, data[].batchable, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/webhooks

  • Read

    Get a webhook

    When providing an invalid webhook id Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.url, data.events, data.enabled, data.secret, data.created_at, data.updated_at, data.batchable.

    GET /api/webhooks/{webhook_id}

  • Write

    Create a webhook

    Documented Parameter: Type: Required: Limitations: name: string: no: ; events: array: yes: Must be one of the events described in following table; url: string: yes: ; enabled: boolean: no: ; batchable: boolean: no: Required as true only for campaign.open and campaign.click events. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.url, data.events, data.enabled, data.secret, data.created_at, data.updated_at, data.batchable.

    POST /api/webhooks

  • Write

    Update a webhook

    Documented Parameter: Type: Required: Limitations: name: string: no: ; events: array: no: ; url: string: no: ; enabled: boolean: no: ; batchable: boolean: no: Required as true only for campaign.open and campaign.click events. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.url, data.events, data.enabled, data.secret, data.created_at, data.updated_at, data.batchable.

    PUT /api/webhooks/{webhook_id}

  • Destructive

    Delete a webhook

    DELETE /api/webhooks/{webhook_id}

E-commerce

  • Read

    Get carts

    If you want to get a list of carts for a given shop, send this GET request Notes: resource_id is your own ID for the cart, or null if the cart has none. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: no: Defaults to 100 . Maximum 1000 , larger values are capped; page: integer: no: Defaults to 1; sort: string: no: One of id , created_at . Prefix with - for descending order, e.g. -created_at . Defaults to id. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].resource_id, data[].ecommerce_order_id, data[].checkout_url, data[].cart_total, data[].customer, data[].customer.id, data[].customer.email, data[].customer.accepts_marketing, data[].customer.total_spent, data[].customer.orders_count, data[].customer.subscriber, data[].customer.subscriber.id, data[].customer.subscriber.email, data[].customer.subscriber.status, data[].customer.subscriber.source, data[].customer.subscriber.sent, data[].customer.subscriber.opens_count, data[].customer.subscriber.clicks_count, data[].customer.subscriber.open_rate, data[].customer.subscriber.click_rate, data[].customer.subscriber.ip_address, data[].customer.subscriber.subscribed_at, data[].customer.subscriber.unsubscribed_at, data[].customer.subscriber.created_at, data[].customer.subscriber.updated_at, data[].customer.subscriber.fields, data[].customer.subscriber.fields.city, data[].customer.subscriber.fields.company, data[].customer.subscriber.fields.country, data[].customer.subscriber.fields.last_name, data[].customer.subscriber.fields.name, data[].customer.subscriber.fields.phone, data[].customer.subscriber.fields.state, data[].customer.subscriber.fields.z_i_p, data[].customer.subscriber.groups, data[].customer.subscriber.opted_in_at, data[].customer.subscriber.optin_ip, data[].items, data[].items[].id, data[].items[].product, data[].items[].product.id, data[].items[].product.name, data[].items[].product.price, data[].items[].product.url, data[].items[].product.image, data[].items[].product.exclude_from_automations, data[].items[].product.enabled, data[].items[].product.categories, data[].items[].product.categories[].id, data[].items[].product.categories[].name, data[].items[].product.categories[].exclude_from_automations, data[].items[].product.categories[].created_at, data[].items[].product.categories[].updated_at, data[].items[].variant, data[].items[].quantity, data[].items[].price, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total. If you want to fetch total carts count, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/ecommerce/shops/{shop_id}/carts

  • Read

    Fetch a cart

    If you want to fetch a cart, please send this GET request If the shop and the cart exist: If the cart or shop cannot be found: Documented Parameter: Type: Required: Limitations: cart_id: integer: yes: Must provide valid cart id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.resource_id, data.ecommerce_order_id, data.checkout_url, data.cart_total, data.customer, data.customer.id, data.customer.email, data.customer.accepts_marketing, data.customer.total_spent, data.customer.orders_count, data.customer.subscriber, data.customer.subscriber.id, data.customer.subscriber.email, data.customer.subscriber.status, data.customer.subscriber.source, data.customer.subscriber.sent, data.customer.subscriber.opens_count, data.customer.subscriber.clicks_count, data.customer.subscriber.open_rate, data.customer.subscriber.click_rate, data.customer.subscriber.ip_address, data.customer.subscriber.subscribed_at, data.customer.subscriber.unsubscribed_at, data.customer.subscriber.created_at, data.customer.subscriber.updated_at, data.customer.subscriber.fields, data.customer.subscriber.fields.city, data.customer.subscriber.fields.company, data.customer.subscriber.fields.country, data.customer.subscriber.fields.last_name, data.customer.subscriber.fields.name, data.customer.subscriber.fields.phone, data.customer.subscriber.fields.state, data.customer.subscriber.fields.z_i_p, data.customer.subscriber.groups, data.customer.subscriber.opted_in_at, data.customer.subscriber.optin_ip, data.items, data.items[].id, data.items[].product, data.items[].product.id, data.items[].product.name, data.items[].product.price, data.items[].product.url, data.items[].product.image, data.items[].product.exclude_from_automations, data.items[].product.enabled, data.items[].product.categories, data.items[].product.categories[].id, data.items[].product.categories[].name, data.items[].product.categories[].exclude_from_automations, data.items[].product.categories[].created_at, data.items[].product.categories[].updated_at, data.items[].variant, data.items[].quantity, data.items[].price.

    GET /api/ecommerce/shops/{shop_id}/carts/{cart_id}

  • Read

    Get the items of a cart

    If you want to get a list items of the given cart, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; cart_id: integer: yes: Must provide valid cart id; limit: integer: no: Defaults to 100 . Maximum 1000 , larger values are capped; page: integer: no: Defaults to 1; sort: string: no: One of id , created_at . Prefix with - for descending order, e.g. -created_at . Defaults to id. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].product, data[].product.id, data[].product.name, data[].product.price, data[].product.url, data[].product.image, data[].product.exclude_from_automations, data[].product.enabled, data[].product.categories, data[].product.categories[].id, data[].product.categories[].name, data[].product.categories[].exclude_from_automations, data[].product.categories[].created_at, data[].product.categories[].updated_at, data[].ecommerce_product_variant_id, data[].variant, data[].quantity, data[].price, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total. If you want to fetch the total cart items count, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; cart_id: integer: yes: Must provide valid cart id; limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/ecommerce/shops/{shop_id}/carts/{cart_id}/items

  • Read

    Fetch a cart item

    If you want to create a cart item, send this GET request If the shop, cart and cart item exist: If the shop, cart or cart item cannot be found: Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; cart_id: integer: yes: Must provide valid cart id; item_id: integer: yes: Must provide valid cart item id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.product, data.product.id, data.product.name, data.product.price, data.product.url, data.product.image, data.product.exclude_from_automations, data.product.enabled, data.product.categories, data.product.categories[].id, data.product.categories[].name, data.product.categories[].exclude_from_automations, data.product.categories[].created_at, data.product.categories[].updated_at, data.ecommerce_product_variant_id, data.variant, data.quantity, data.price.

    GET /api/ecommerce/shops/{shop_id}/carts/{cart_id}/items/{item_id}

  • Read

    Get categories

    If you want to get all categories of the given shop_id, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: no: Defaults to 100 . Maximum 1000 , larger values are capped; page: integer: no: Defaults to 1; sort: string: no: One of id , name , created_at . Prefix with - for descending order, e.g. -created_at . Defaults to id. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].exclude_from_automations, data[].created_at, data[].updated_at, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total. If you want to fetch the count of all categories, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/ecommerce/shops/{shop_id}/categories

  • Read

    Fetch a category

    If you want to fetch a category for a given shop, send this GET request If the shop and the category exist: If the category or shop cannot be found: Documented Parameter: Type: Required: Limitations: category_id: integer: yes: Must provide valid category id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.exclude_from_automations, data.created_at, data.updated_at.

    GET /api/ecommerce/shops/{shop_id}/categories/{category_id}

  • Read

    Get the products of a category

    If you want to get the products for a particular shop and a category, send this GET request Products are returned in ascending order of their ID. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; category_id: integer: yes: Must provide category id; limit: integer: no: Defaults to 100 . Maximum 1000 , larger values are capped; page: integer: no: Defaults to 1. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].price, data[].url, data[].image, data[].exclude_from_automations, data[].enabled, data[].categories, data[].categories[].id, data[].categories[].name, data[].categories[].exclude_from_automations, data[].categories[].created_at, data[].categories[].updated_at, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total.

    GET /api/ecommerce/shops/{shop_id}/categories/{category_id}/products

  • Read

    Get customers

    If you want to get a list of customers for the given shop, send this GET request To look up a customer by email address, send Notes: The subscriber field will be null if no subscriber exists for the customer. Filters other than filter[email] are ignored. If you use a sort field that this endpoint doesn't support: Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: no: Defaults to 100. Maximum 1000, larger values are capped; page: integer: no: Defaults to 1; sort: string: no: One of id , email , created_at . Prefix with - for descending order, e.g. -created_at . Defaults to id; filter[email]: string: no: Returns only the customer with this email address. Exact match, case-insensitive. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].email, data[].accepts_marketing, data[].total_spent, data[].orders_count, data[].subscriber, data[].subscriber.id, data[].subscriber.email, data[].subscriber.status, data[].subscriber.source, data[].subscriber.sent, data[].subscriber.opens_count, data[].subscriber.clicks_count, data[].subscriber.open_rate, data[].subscriber.click_rate, data[].subscriber.ip_address, data[].subscriber.subscribed_at, data[].subscriber.unsubscribed_at, data[].subscriber.created_at, data[].subscriber.updated_at, data[].subscriber.fields, data[].subscriber.fields.city, data[].subscriber.fields.company, data[].subscriber.fields.country, data[].subscriber.fields.last_name, data[].subscriber.fields.name, data[].subscriber.fields.phone, data[].subscriber.fields.state, data[].subscriber.fields.z_i_p, data[].subscriber.groups, data[].subscriber.opted_in_at, data[].subscriber.optin_ip, data[].created_at, data[].updated_at, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total. If you want to fetch total customers count for the given shop, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/ecommerce/shops/{shop_id}/customers

  • Read

    Fetch a customer

    If you want to fetch a customer for the given shop, send this GET request If the shop and the customer exist: Notes: The subscriber field will be null if no subscriber exists for the customer. If the customer or shop cannot be found: Documented Parameter: Type: Required: Limitations: customer_id: integer: yes: Must provide valid customer id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.email, data.accepts_marketing, data.total_spent, data.orders_count, data.subscriber, data.subscriber.id, data.subscriber.email, data.subscriber.status, data.subscriber.source, data.subscriber.sent, data.subscriber.opens_count, data.subscriber.clicks_count, data.subscriber.open_rate, data.subscriber.click_rate, data.subscriber.ip_address, data.subscriber.subscribed_at, data.subscriber.unsubscribed_at, data.subscriber.created_at, data.subscriber.updated_at, data.subscriber.fields, data.subscriber.fields.city, data.subscriber.fields.company, data.subscriber.fields.country, data.subscriber.fields.last_name, data.subscriber.fields.name, data.subscriber.fields.phone, data.subscriber.fields.state, data.subscriber.fields.z_i_p, data.subscriber.groups, data.subscriber.opted_in_at, data.subscriber.optin_ip.

    GET /api/ecommerce/shops/{shop_id}/customers/{customer_id}

  • Read

    Get orders

    If you want to get orders for the given shop, send this GET request Get a list of orders for the given shop. To get the orders attributed to one campaign or automation email, send If a filter has an invalid value, for example filter[attributed]=maybe , filter[status]=shipped or a non-numeric filter[email_id] or filter[customer] : If you use a filter or sort field that this endpoint doesn't support: Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: no: Defaults to 100. Maximum 1000, larger values are capped; page: integer: no: Defaults to 1; sort: string: no: One of id , created_at . Prefix with - for descending order, e.g. -created_at . Defaults to id; filter[status]: string: no: One of pending , complete; filter[customer]: integer: no: Returns only orders placed by the given customer; filter[attributed]: boolean: no: Allowed values: true , false , 1 , 0 . Returns only orders with ( true ) or without ( false ) an attribution.; filter[email_id]: integer: no: Returns only orders attributed to the given email. See Revenue attribution .. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].shop, data[].shop.id, data[].shop.name, data[].shop.url, data[].shop.currency, data[].shop.enabled, data[].shop.enable_popups, data[].shop.group, data[].shop.group.id, data[].shop.group.name, data[].shop.group.total, data[].shop.group.open_rate, data[].shop.group.open_rate.float, data[].shop.group.open_rate.string, data[].shop.group.click_rate, data[].shop.group.click_rate.float, data[].shop.group.click_rate.string, data[].shop.group.created_at, data[].shop.created_at, data[].shop.updated_at, data[].customer, data[].customer.id, data[].customer.email, data[].customer.accepts_marketing, data[].customer.total_spent, data[].customer.orders_count, data[].customer.subscriber, data[].customer.subscriber.id, data[].customer.subscriber.email, data[].customer.subscriber.status, data[].customer.subscriber.source, data[].customer.subscriber.sent, data[].customer.subscriber.opens_count, data[].customer.subscriber.clicks_count, data[].customer.subscriber.open_rate, data[].customer.subscriber.click_rate, data[].customer.subscriber.ip_address, data[].customer.subscriber.subscribed_at, data[].customer.subscriber.unsubscribed_at, data[].customer.subscriber.created_at, data[].customer.subscriber.updated_at, data[].customer.subscriber.fields, data[].customer.subscriber.fields.city, data[].customer.subscriber.fields.company, data[].customer.subscriber.fields.country, data[].customer.subscriber.fields.last_name, data[].customer.subscriber.fields.name, data[].customer.subscriber.fields.phone, data[].customer.subscriber.fields.state, data[].customer.subscriber.fields.z_i_p, data[].customer.subscriber.groups, data[].customer.subscriber.opted_in_at, data[].customer.subscriber.optin_ip, data[].cart, data[].cart.id, data[].cart.resource_id, data[].cart.checkout_url, data[].cart.cart_total, data[].cart.items, data[].cart.items[].id, data[].cart.items[].product, data[].cart.items[].product.id, data[].cart.items[].product.name, data[].cart.items[].product.price, data[].cart.items[].product.url, data[].cart.items[].product.image, data[].cart.items[].product.exclude_from_automations, data[].cart.items[].product.enabled, data[].cart.items[].product.categories, data[].cart.items[].product.categories[].id, data[].cart.items[].product.categories[].name, data[].cart.items[].product.categories[].exclude_from_automations, data[].cart.items[].product.categories[].created_at, data[].cart.items[].product.categories[].updated_at, data[].cart.items[].variant, data[].cart.items[].quantity, data[].cart.items[].price, data[].total, data[].status, data[].attribution, data[].attribution.email_id, data[].attribution.type, data[].created_at, data[].updated_at, data[].completed_at, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total. If you want to fetch total orders count for the given shop, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/ecommerce/shops/{shop_id}/orders

  • Read

    Fetch an order

    If you want to fetch an order for the given shop, send this GET request If the shop and the order exist: If the order or shop cannot be found: Documented Parameter: Type: Required: Limitations: order_id: integer: yes: Must provide valid order id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.shop, data.shop.id, data.shop.name, data.shop.url, data.shop.currency, data.shop.enabled, data.shop.enable_popups, data.shop.group, data.shop.group.id, data.shop.group.name, data.shop.group.total, data.shop.group.open_rate, data.shop.group.open_rate.float, data.shop.group.open_rate.string, data.shop.group.click_rate, data.shop.group.click_rate.float, data.shop.group.click_rate.string, data.shop.group.created_at, data.shop.created_at, data.shop.updated_at, data.customer, data.customer.id, data.customer.email, data.customer.accepts_marketing, data.customer.total_spent, data.customer.orders_count, data.customer.subscriber, data.customer.subscriber.id, data.customer.subscriber.email, data.customer.subscriber.status, data.customer.subscriber.source, data.customer.subscriber.sent, data.customer.subscriber.opens_count, data.customer.subscriber.clicks_count, data.customer.subscriber.open_rate, data.customer.subscriber.click_rate, data.customer.subscriber.ip_address, data.customer.subscriber.subscribed_at, data.customer.subscriber.unsubscribed_at, data.customer.subscriber.created_at, data.customer.subscriber.updated_at, data.customer.subscriber.fields, data.customer.subscriber.fields.city, data.customer.subscriber.fields.company, data.customer.subscriber.fields.country, data.customer.subscriber.fields.last_name, data.customer.subscriber.fields.name, data.customer.subscriber.fields.phone, data.customer.subscriber.fields.state, data.customer.subscriber.fields.z_i_p, data.customer.subscriber.groups, data.customer.subscriber.opted_in_at, data.customer.subscriber.optin_ip, data.cart, data.cart.id, data.cart.resource_id, data.cart.checkout_url, data.cart.cart_total, data.cart.items, data.cart.items[].id, data.cart.items[].product, data.cart.items[].product.id, data.cart.items[].product.name, data.cart.items[].product.price, data.cart.items[].product.url, data.cart.items[].product.image, data.cart.items[].product.exclude_from_automations, data.cart.items[].product.enabled, data.cart.items[].product.categories, data.cart.items[].product.categories[].id, data.cart.items[].product.categories[].name, data.cart.items[].product.categories[].exclude_from_automations, data.cart.items[].product.categories[].created_at, data.cart.items[].product.categories[].updated_at, data.cart.items[].variant, data.cart.items[].quantity, data.cart.items[].price, data.total, data.status, data.attribution, data.attribution.email_id, data.attribution.type, data.created_at, data.updated_at, data.completed_at.

    GET /api/ecommerce/shops/{shop_id}/orders/{order_id}

  • Read

    Get product variants

    If you want to get the variants of the given product, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; product_id: integer: yes: Must provide valid product id. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].attributes, data[].attributes.color, data[].attributes.size, data[].price, data[].price_type, data[].resource_id, data[].image_url.

    GET /api/ecommerce/shops/{shop_id}/products/{product_id}/variants

  • Read

    Get products

    If you want to get products for the given shop, send this GET request To get the enabled products of one category, send If a filter has an invalid value, for example filter[type]=digital or filter[enabled]=maybe : If you use a filter or sort field that this endpoint doesn't support: Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: no: Defaults to 100 . Maximum 1000 , larger values are capped; page: integer: no: Defaults to 1; sort: string: no: One of id , name , created_at . Prefix with - for descending order, e.g. -created_at . Defaults to id; filter[name]: string: no: Returns only products whose name contains the value; filter[type]: string: no: One of one-time , subscription , booking; filter[enabled]: boolean: no: Allowed values: true , false , 1 , 0 . Returns only enabled ( true ) or disabled ( false ) products; filter[category]: integer: no: Returns only products assigned to the given category; filter[exclude_from_automations]: boolean: no: Allowed values: true , false , 1 , 0; type: string: no: MailerLite shop only. Older form of filter[type] , use filter[type] instead. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].price, data[].url, data[].image, data[].exclude_from_automations, data[].enabled, data[].short_description, data[].description, data[].categories, data[].categories[].id, data[].categories[].name, data[].categories[].exclude_from_automations, data[].categories[].created_at, data[].categories[].updated_at, data[].variants, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total. If you want to fetch the total products count for the given shop, send this GET request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/ecommerce/shops/{shop_id}/products

  • Read

    Fetch a product

    If you want to fetch a product for the given shop, send this GET request If the shop and the product exist: If the product or shop cannot be found: Documented Parameter: Type: Required: Limitations: product_id: integer: yes: Must provide valid product id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.enabled, data.short_description, data.description, data.categories, data.categories[].id, data.categories[].name, data.categories[].exclude_from_automations, data.categories[].created_at, data.categories[].updated_at, data.variants.

    GET /api/ecommerce/shops/{shop_id}/products/{product_id}

  • Read

    Get e-commerce tracking settings

    If you want to check whether orders are attributed to your campaigns and automations, send this GET request These are account defaults, copied to each campaign or automation when it is created. To check or change tracking on one item, use settings.ecommerce_tracking on the campaign or trigger_data.track_ecommerce on the automation . Documented Field: Type: Description: ecommerce_tracking_in_campaigns: boolean: Whether new campaigns track e-commerce. Defaults to false .; ecommerce_tracking_in_automations: boolean: Whether new automations track e-commerce. Always false while you have no enabled shop.; ecommerce_attribution_window: integer: Days after a click during which a purchase is attributed to the email. Defaults to 30.. Documented JSON-example fields (not a formal required-field schema): data, data.ecommerce_tracking_in_campaigns, data.ecommerce_tracking_in_automations, data.ecommerce_attribution_window.

    GET /api/ecommerce/settings

  • Read

    List e-commerce shops

    If you want to get a list of all available shops connected to your account, send this GET request Documented Parameter: Type: Required: Limitations: limit: integer: no: Defaults to 50; page: integer: no: Defaults to 1. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].url, data[].currency, data[].enabled, data[].enable_popups, data[].group, data[].group.id, data[].group.name, data[].group.total, data[].group.open_rate, data[].group.open_rate.float, data[].group.open_rate.string, data[].group.click_rate, data[].group.click_rate.float, data[].group.click_rate.string, data[].group.created_at, data[].created_at, data[].updated_at, data[].currency_sign, links, links.first, links.last, links.prev, links.next, meta, meta.current_page, meta.from, meta.last_page, meta.links, meta.links[].url, meta.links[].label, meta.links[].active, meta.path, meta.per_page, meta.to, meta.total. If you want to fetch total shops count, send this GET request Documented Parameter: Type: Required: Limitations: limit: integer: yes: Value must be 0. Documented JSON-example fields (not a formal required-field schema): total.

    GET /api/ecommerce/shops

  • Read

    Fetch a shop

    To fetch a shop, send this GET request If shop exists: If the shop cannot be found: Documented Parameter: Type: Required: Limitations: id: integer: yes: Must provide either valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.url, data.currency, data.enabled, data.enable_popups, data.group, data.group.id, data.group.name, data.group.total, data.group.open_rate, data.group.open_rate.float, data.group.open_rate.string, data.group.click_rate, data.group.click_rate.float, data.group.click_rate.string, data.group.created_at, data.created_at, data.updated_at, data.currency_sign.

    GET /api/ecommerce/shops/{shop_id}

  • Read

    Fetch shop e-commerce stats

    To get the orders and revenue your emails earned in a shop over a period, send this GET request series has one entry per day in the period. If the shop cannot be found: Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide a valid shop id; start_date: string: yes: First day of the period, as YYYY-MM-DD; end_date: string: yes: Last day of the period, as YYYY-MM-DD . Must not be before start_date. Documented JSON-example fields (not a formal required-field schema): data, data.ecommerce, data.ecommerce.orders_count, data.ecommerce.revenue, data.ecommerce.average_order_value, data.ecommerce.conversion_rate, data.series, data.series[].date, data.series[].campaign_orders_count, data.series[].automation_orders_count, data.series[].automation_revenue, data.series[].campaign_revenue.

    GET /api/ecommerce/shops/{shop_id}/reports/stats

  • Write

    Update a cart

    If you want to update a cart, please send this PUT request Note: Carts can only be created through the orders endpoint. If the cart was updated: Notes: You can use the respective cart items endpoints to update a cart's items. If the resource_id you send already belongs to another cart in the shop, nothing is saved and the response shows the cart as it is stored. Documented Parameter: Type: Required: Limitations: checkout_url: string: no: The cart's checkout url.; cart_total: float: no: The cart's total price in the shop's currency. Defaults to 0 .; ecommerce_customer_id: integer: no: The MailerLite ID of the customer this cart belongs to. Must be a customer of the same shop.; resource_id: string: no: Your own ID for this cart, so you can address it by your identifier instead of the MailerLite one. Must be unique within the shop.. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.resource_id, data.ecommerce_order_id, data.checkout_url, data.cart_total, data.customer, data.customer.id, data.customer.email, data.customer.accepts_marketing, data.customer.total_spent, data.customer.orders_count, data.customer.subscriber, data.customer.subscriber.id, data.customer.subscriber.email, data.customer.subscriber.status, data.customer.subscriber.source, data.customer.subscriber.sent, data.customer.subscriber.opens_count, data.customer.subscriber.clicks_count, data.customer.subscriber.open_rate, data.customer.subscriber.click_rate, data.customer.subscriber.ip_address, data.customer.subscriber.subscribed_at, data.customer.subscriber.unsubscribed_at, data.customer.subscriber.created_at, data.customer.subscriber.updated_at, data.customer.subscriber.fields, data.customer.subscriber.fields.city, data.customer.subscriber.fields.company, data.customer.subscriber.fields.country, data.customer.subscriber.fields.last_name, data.customer.subscriber.fields.name, data.customer.subscriber.fields.phone, data.customer.subscriber.fields.state, data.customer.subscriber.fields.z_i_p, data.customer.subscriber.groups, data.customer.subscriber.opted_in_at, data.customer.subscriber.optin_ip, data.items, data.items[].id, data.items[].product, data.items[].product.id, data.items[].product.name, data.items[].product.price, data.items[].product.url, data.items[].product.image, data.items[].product.exclude_from_automations, data.items[].product.enabled, data.items[].product.categories, data.items[].product.categories[].id, data.items[].product.categories[].name, data.items[].product.categories[].exclude_from_automations, data.items[].product.categories[].created_at, data.items[].product.categories[].updated_at, data.items[].variant, data.items[].quantity, data.items[].price.

    PUT /api/ecommerce/shops/{shop_id}/carts/{cart_id}

  • Write

    Add/update a cart item

    You can add or update a cart item. If you want to create a cart item for a given shop, use this POST request If you want to update the cart item for the given shop, use this PUT request If the cart item was created: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: ecommerce_product_id: integer: yes: The id of the product to add to the cart; ecommerce_product_variant_id: integer: no: The id of the product variant; variant: string: no: The product's variant information.; quantity: integer: no: The products quantity. Defaults to 1 .; price: float: no: The cart item's price. Defaults to 0 .. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.product, data.product.id, data.product.name, data.product.price, data.product.url, data.product.image, data.product.exclude_from_automations, data.product.enabled, data.product.categories, data.product.categories[].id, data.product.categories[].name, data.product.categories[].exclude_from_automations, data.product.categories[].created_at, data.product.categories[].updated_at, data.ecommerce_product_variant_id, data.variant, data.quantity, data.price. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.ecommerce_product_id.

    POST /api/ecommerce/shops/{shop_id}/carts/{cart_id}/items

  • Write

    Create/update category

    You can create or update the category of the given shop. If you want to create the category, send this POST request If you want to update the category, send this PUT request If the category was created: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: name: string: yes: The category's name; exclude_from_automations: boolean: no: If true this category will not trigger any automations. Defaults to false. Documented JSON-example fields (not a formal required-field schema): id, name, exclude_from_automations, created_at, updated_at. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.exclude_from_automations, data.created_at, data.updated_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.name.

    POST /api/ecommerce/shops/{shop_id}/categories

  • Write

    Assign a product to a category

    If you want to assign a product to a category for a given shop, send this PUT request If the product was assigned to the category: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; category_id: integer: yes: Must provide category id; product_id: integer: yes: Must provide product id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.enabled, data.categories, data.categories[].id, data.categories[].name, data.categories[].exclude_from_automations, data.categories[].created_at, data.categories[].updated_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.product_id.

    PUT /api/ecommerce/shops/{shop_id}/categories/{category_id}/products/{product_id}

  • Write

    Categories import

    If you want to import multiple categories for the given shop, send this POST request If the categories were created: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): [].name, [].exclude_from_automations. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].exclude_from_automations, data[].created_at, data[].updated_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.0.name.

    POST /api/ecommerce/shops/{shop_id}/categories/import

  • Write

    Customers import

    If you want to import multiple customers for the given shop, send this POST request Customers are saved in the background, so the response returns the accepted data. The error response will contain information about the invalid data. Returned when the customers would exceed the account's subscriber limit. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): [].email, [].resource_id, [].accepts_marketing, [].create_subscriber, [].total_spent, [].orders_count. Documented JSON-example fields (not a formal required-field schema): data, data[].resource_id, data[].email, data[].accepts_marketing, data[].create_subscriber. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.0.email.

    POST /api/ecommerce/shops/{shop_id}/customers/import

  • Write

    Products import

    If you want to import products for the given shop, use this POST request If the products were created: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): [].name, [].price, [].url, [].image, [].exclude_from_automations, [].categories. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].name, data[].price, data[].url, data[].image, data[].exclude_from_automations, data[].enabled, data[].categories, data[].categories[].id, data[].categories[].name, data[].categories[].exclude_from_automations, data[].categories[].created_at, data[].categories[].updated_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.0.name.

    POST /api/ecommerce/shops/{shop_id}/products/import

  • Write

    Orders import

    If you want to import orders including customers, carts and cart items for the given shop, send this POST request Each order's customer object takes the same fields as Create/update customer , including the optional name and last_name (strings, max 255 characters). They are saved to the subscriber's Name and Last name fields. An empty or null value leaves the existing value unchanged. If a name is invalid, the validation error is reported under orders.N.customer . If the orders were created: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): [].customer, [].customer.email, [].customer.create_subscriber, [].customer.accepts_marketing, [].customer.name, [].customer.last_name, [].cart, [].cart.items, [].cart.items[].ecommerce_product_id, [].cart.items[].variant, [].cart.items[].quantity, [].cart.items[].price, [].status, [].total_price. Documented JSON-example fields (not a formal required-field schema): data, data[].id, data[].customer, data[].customer.id, data[].customer.email, data[].customer.accepts_marketing, data[].customer.total_spent, data[].customer.orders_count, data[].customer.subscriber, data[].customer.subscriber.id, data[].customer.subscriber.email, data[].customer.subscriber.status, data[].customer.subscriber.source, data[].customer.subscriber.sent, data[].customer.subscriber.opens_count, data[].customer.subscriber.clicks_count, data[].customer.subscriber.open_rate, data[].customer.subscriber.click_rate, data[].customer.subscriber.ip_address, data[].customer.subscriber.subscribed_at, data[].customer.subscriber.unsubscribed_at, data[].customer.subscriber.created_at, data[].customer.subscriber.updated_at, data[].customer.subscriber.opted_in_at, data[].customer.subscriber.optin_ip, data[].cart, data[].cart.id, data[].cart.resource_id, data[].cart.checkout_url, data[].cart.cart_total, data[].cart.items, data[].cart.items[].id, data[].cart.items[].product, data[].cart.items[].product.id, data[].cart.items[].product.name, data[].cart.items[].product.price, data[].cart.items[].product.url, data[].cart.items[].product.image, data[].cart.items[].product.exclude_from_automations, data[].cart.items[].product.enabled, data[].cart.items[].product.categories, data[].cart.items[].product.categories[].id, data[].cart.items[].product.categories[].name, data[].cart.items[].product.categories[].exclude_from_automations, data[].cart.items[].product.categories[].created_at, data[].cart.items[].product.categories[].updated_at, data[].cart.items[].variant, data[].cart.items[].quantity, data[].cart.items[].price, data[].total, data[].status, data[].attribution, data[].created_at, data[].updated_at, data[].completed_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.0.customer.

    POST /api/ecommerce/shops/{shop_id}/orders/import

  • Write

    Update a product variant

    If you want to update a variant of the given product, send this PUT request Returns the product with its variants, in the same format as Create product variants . If the shop, product or variant cannot be found: Documented Parameter: Type: Required: Limitations: name: string: yes: The variant's name; attributes: object: yes: The variant's attributes, e.g. {"color": "Black"}; price_type: string: no: Either fixed or increment; price: float: no: The variant's price. Required when price_type is provided; resource_id: string: no: The variant's id in your shop; image_url: string: no: The variant's image url. Documented JSON-example fields (not a formal required-field schema): name, attributes, attributes.color, attributes.size.

    PUT /api/ecommerce/shops/{shop_id}/products/{product_id}/variants/{variant_id}

  • Write

    Create/update product

    You can create or update a product for the given shop. To create a product for the given shop, send this POST request To update a product for the given shop, send this PUT request If the product was created: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: name: string: yes: The product's name; price: float: no: The product's price in the shop's currency. Defaults to 0 .; exclude_from_automations: boolean: no: If true this product will not trigger any automations. Defaults to false; enabled: boolean: no: Whether the product is enabled. Defaults to true; url: string: no: The products url.; image: string: no: The products main image url.; short_description: string: no: The product's short description. Max 255 characters. HTML tags are automatically removed; description: string: no: The product's description. HTML tags are automatically removed.. Documented JSON-example fields (not a formal required-field schema): name, price, url, image, exclude_from_automations, short_description, description. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.enabled, data.short_description, data.description, data.categories, data.variants. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.name.

    POST /api/ecommerce/shops/{shop_id}/products

  • Write

    Enable or disable a product

    If you want to enable or disable a product for the given shop, send this PUT request Documented Parameter: Type: Required: Limitations: product_id: integer: yes: Must provide valid product id; shop_id: integer: yes: Must provide valid shop id; status: boolean: yes: true to enable, false to disable. Documented JSON-example fields (not a formal required-field schema): status. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.enabled, data.short_description, data.description, data.categories, data.variants.

    PUT /api/ecommerce/shops/{shop_id}/products/{product_id}/change-status

  • Write

    Create/update shop

    You can create or update a shop. To create a shop, send this POST request To update a shop, send this PUT request If the shop was created: The error response will contain information about the invalid data. If you try to update the MailerLite shop: Documented Parameter: Type: Required: Limitations: name: string: yes: Shop name; url: string: yes: Shop URL address; currency: string: yes: ISO 4217 currency code that the shop uses.; platform: string: no: The platform of the shop (e.g. shopify); group_id: integer: no: The id of the group that the shop's subscribers are automatically added to.; enable_popups: boolean: no: Enables popups to the shop (the shop must have the universal script added to it). Defaults to false .; enabled: boolean: no: Enable/disable the ecommerce functionality for the shop. Defaults to false .; access_data: string: no: 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.. Documented JSON-example fields (not a formal required-field schema): name, url, currency, group_id, enable_popups, enabled. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.url, data.currency, data.enabled, data.enable_popups, data.group, data.group.id, data.group.name, data.group.total, data.group.open_rate, data.group.open_rate.float, data.group.open_rate.string, data.group.click_rate, data.group.click_rate.float, data.group.click_rate.string, data.group.created_at, data.created_at, data.updated_at, data.currency_sign. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.url.

    POST /api/ecommerce/shops

  • Destructive

    Delete a cart item

    If you want to delete a cart item, send this DELETE request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; cart_id: integer: yes: Must provide valid cart id; item_id: integer: yes: Must provide valid cart item id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.product, data.product.id, data.product.name, data.product.price, data.product.url, data.product.image, data.product.exclude_from_automations, data.product.enabled, data.product.categories, data.product.categories[].id, data.product.categories[].name, data.product.categories[].exclude_from_automations, data.product.categories[].created_at, data.product.categories[].updated_at, data.ecommerce_product_variant_id, data.variant, data.quantity, data.price.

    DELETE /api/ecommerce/shops/{shop_id}/carts/{cart_id}/items/{item_id}

  • Destructive

    Delete a category

    If you want to delete a category for the given shop, send this DELETE request Documented Parameter: Type: Required: Limitations: category_id: integer: yes: Must provide valid category id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): id, name, exclude_from_automations, created_at, updated_at.

    DELETE /api/ecommerce/shops/{shop_id}/categories/{category_id}

  • Destructive

    Assign multiple categories to a product

    If you want to assign multiple categories to a product for a given shop, send this PUT request If the categories were assigned to the product: The error response will contain information about the invalid data. Returned when a category does not belong to the shop. Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; product_id: integer: yes: Must provide product id; categories: array: yes: Category ids, max 100; replace: boolean: no: If true , removes the product from categories not in the list. Documented JSON-example fields (not a formal required-field schema): categories, replace. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.categories, data.categories[].id, data.categories[].name, data.categories[].exclude_from_automations, data.categories[].created_at, data.categories[].updated_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.categories.

    PUT /api/ecommerce/shops/{shop_id}/products/{product_id}/categories/multiple

  • Destructive

    Unassign a product from a category

    If you want to unassign a product from a category for a given shop, send this DELETE request Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; category_id: integer: yes: Must provide category id; product_id: integer: yes: Must provide product id. Documented JSON-example fields (not a formal required-field schema): id, name, price, url, image, exclude_from_automations, enabled, categories, categories[].id, categories[].name, categories[].exclude_from_automations, categories[].created_at, categories[].updated_at.

    DELETE /api/ecommerce/shops/{shop_id}/categories/{category_id}/products/{product_id}

  • Destructive

    Create/update customer

    You can create or update a customer for the given shop. If you want to create a customer, send this POST request If you want to update the customer, send this PUT request If the customer was created: Notes: The subscriber field will be null if no subscriber exists for the customer. If a subscriber exists with the same email as the customer, the customer will be associated with that subscriber. Doing a PUT request with create_subscriber set to false on a customer that has a subscriber associated, has no effect. Doing a PUT request with create_subscriber set to true on a customer that doesn't have a subscriber, creates the subscriber. name and last_name are only saved when the customer has a subscriber, either because create_subscriber is true or because a subscriber with the same email already exists. A non-empty value overwrites the subscriber's current Name or Last name. An empty or null value leaves it unchanged. The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: email: string: yes: Customer's email address; accepts_marketing: boolean: no: True if the customer accepts marketing emails, false otherwise; total_spent: float: no: The total amount the customer has spent in the shop.; create_subscriber: boolean: no: If set, a subscriber will be created for the customer.; name: string: no: Customer's first name. Max 255 characters. Saved to the subscriber's Name field.; last_name: string: no: Customer's last name. Max 255 characters. Saved to the subscriber's Last name field.. Documented JSON-example fields (not a formal required-field schema): email, accepts_marketing, total_spent, create_subscriber, name, last_name. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.email, data.accepts_marketing, data.total_spent, data.orders_count, data.subscriber, data.subscriber.id, data.subscriber.email, data.subscriber.status, data.subscriber.source, data.subscriber.sent, data.subscriber.opens_count, data.subscriber.clicks_count, data.subscriber.open_rate, data.subscriber.click_rate, data.subscriber.ip_address, data.subscriber.subscribed_at, data.subscriber.unsubscribed_at, data.subscriber.created_at, data.subscriber.updated_at, data.subscriber.fields, data.subscriber.fields.city, data.subscriber.fields.company, data.subscriber.fields.country, data.subscriber.fields.last_name, data.subscriber.fields.name, data.subscriber.fields.phone, data.subscriber.fields.state, data.subscriber.fields.z_i_p, data.subscriber.groups, data.subscriber.opted_in_at, data.subscriber.optin_ip, data.created_at, data.updated_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.email.

    POST /api/ecommerce/shops/{shop_id}/customers

  • Destructive

    Delete a customer

    If you want to delete a customer for the given shop, send this DELETE request Notes: The subscriber field will be null if no subscriber exists for the customer. If a subscriber is associated with the customer, the subscriber will not be deleted or affected. Documented Parameter: Type: Required: Limitations: customer_id: integer: yes: Must provide valid customer id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.email, data.accepts_marketing, data.total_spent, data.orders_count, data.subscriber, data.subscriber.id, data.subscriber.email, data.subscriber.status, data.subscriber.source, data.subscriber.sent, data.subscriber.opens_count, data.subscriber.clicks_count, data.subscriber.open_rate, data.subscriber.click_rate, data.subscriber.ip_address, data.subscriber.subscribed_at, data.subscriber.unsubscribed_at, data.subscriber.created_at, data.subscriber.updated_at, data.subscriber.fields, data.subscriber.fields.city, data.subscriber.fields.company, data.subscriber.fields.country, data.subscriber.fields.last_name, data.subscriber.fields.name, data.subscriber.fields.phone, data.subscriber.fields.state, data.subscriber.fields.z_i_p, data.subscriber.groups, data.subscriber.opted_in_at, data.subscriber.optin_ip.

    DELETE /api/ecommerce/shops/{shop_id}/customers/{customer_id}

  • Destructive

    Create/update order

    You can create or update an order for the given shop. If you want to create an order for the given shop, send this POST request If you want to update an order for the given shop, send this PUT request Notes: The customer will be created if a customer with the same email doesn't already exist in the platform. You can send the customer's name and last_name (strings, max 255 characters) in the customer object. They are saved to the subscriber's Name and Last name fields, so they only take effect when the customer has a subscriber. A non-empty value overwrites the subscriber's current value. An empty or null value leaves it unchanged. See Create/update customer . You cannot update the cart or the customer of an order through the PUT endpoint. You'll have to use the respective Customer and Cart endpoints instead. You cannot set the order's attribution. MailerLite ignores email_id in the request body and calculates the attribution itself. See Revenue attribution . If the order was created: The error response will contain information about the invalid data. Documented Parameter: Type: Required: Limitations: customer: array: yes: The customer information. Check the respective ecommerce customer api documentation.; cart: array: yes: The order cart. Check the respective ecommerce cart api documentation.; status: string: no: The order's status. Allowed values: pending , complete . Defaults to pending .; total_price: float: no: The order's total price. Defaults to 0 .. Documented JSON-example fields (not a formal required-field schema): customer, customer.email, customer.create_subscriber, customer.accepts_marketing, customer.name, customer.last_name, cart, cart.items, cart.items[].ecommerce_product_id, cart.items[].variant, cart.items[].quantity, cart.items[].price, status, total_price. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.shop, data.shop.id, data.shop.name, data.shop.url, data.shop.currency, data.shop.enabled, data.shop.enable_popups, data.shop.group, data.shop.group.id, data.shop.group.name, data.shop.group.total, data.shop.group.open_rate, data.shop.group.open_rate.float, data.shop.group.open_rate.string, data.shop.group.click_rate, data.shop.group.click_rate.float, data.shop.group.click_rate.string, data.shop.group.created_at, data.shop.created_at, data.shop.updated_at, data.customer, data.customer.id, data.customer.email, data.customer.accepts_marketing, data.customer.total_spent, data.customer.orders_count, data.customer.subscriber, data.customer.subscriber.id, data.customer.subscriber.email, data.customer.subscriber.status, data.customer.subscriber.source, data.customer.subscriber.sent, data.customer.subscriber.opens_count, data.customer.subscriber.clicks_count, data.customer.subscriber.open_rate, data.customer.subscriber.click_rate, data.customer.subscriber.ip_address, data.customer.subscriber.subscribed_at, data.customer.subscriber.unsubscribed_at, data.customer.subscriber.created_at, data.customer.subscriber.updated_at, data.customer.subscriber.fields, data.customer.subscriber.fields.city, data.customer.subscriber.fields.company, data.customer.subscriber.fields.country, data.customer.subscriber.fields.last_name, data.customer.subscriber.fields.name, data.customer.subscriber.fields.phone, data.customer.subscriber.fields.state, data.customer.subscriber.fields.z_i_p, data.customer.subscriber.groups, data.customer.subscriber.opted_in_at, data.customer.subscriber.optin_ip, data.cart, data.cart.id, data.cart.resource_id, data.cart.checkout_url, data.cart.cart_total, data.cart.items, data.cart.items[].id, data.cart.items[].product, data.cart.items[].product.id, data.cart.items[].product.name, data.cart.items[].product.price, data.cart.items[].product.url, data.cart.items[].product.image, data.cart.items[].product.exclude_from_automations, data.cart.items[].product.enabled, data.cart.items[].product.categories, data.cart.items[].product.categories[].id, data.cart.items[].product.categories[].name, data.cart.items[].product.categories[].exclude_from_automations, data.cart.items[].product.categories[].created_at, data.cart.items[].product.categories[].updated_at, data.cart.items[].variant, data.cart.items[].quantity, data.cart.items[].price, data.total, data.status, data.attribution, data.created_at, data.updated_at, data.completed_at. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.customer.

    POST /api/ecommerce/shops/{shop_id}/orders

  • Destructive

    Delete an order

    If you want to delete an order, send this DELETE request Notes: Deleting an order will also delete the associated cart and cart items. Documented Parameter: Type: Required: Limitations: order_id: integer: yes: Must provide valid order id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.shop, data.shop.id, data.shop.name, data.shop.url, data.shop.currency, data.shop.enabled, data.shop.enable_popups, data.shop.group, data.shop.group.id, data.shop.group.name, data.shop.group.total, data.shop.group.open_rate, data.shop.group.open_rate.float, data.shop.group.open_rate.string, data.shop.group.click_rate, data.shop.group.click_rate.float, data.shop.group.click_rate.string, data.shop.group.created_at, data.shop.created_at, data.shop.updated_at, data.customer, data.customer.id, data.customer.email, data.customer.accepts_marketing, data.customer.total_spent, data.customer.orders_count, data.customer.subscriber, data.customer.subscriber.id, data.customer.subscriber.email, data.customer.subscriber.status, data.customer.subscriber.source, data.customer.subscriber.sent, data.customer.subscriber.opens_count, data.customer.subscriber.clicks_count, data.customer.subscriber.open_rate, data.customer.subscriber.click_rate, data.customer.subscriber.ip_address, data.customer.subscriber.subscribed_at, data.customer.subscriber.unsubscribed_at, data.customer.subscriber.created_at, data.customer.subscriber.updated_at, data.customer.subscriber.fields, data.customer.subscriber.fields.city, data.customer.subscriber.fields.company, data.customer.subscriber.fields.country, data.customer.subscriber.fields.last_name, data.customer.subscriber.fields.name, data.customer.subscriber.fields.phone, data.customer.subscriber.fields.state, data.customer.subscriber.fields.z_i_p, data.customer.subscriber.groups, data.customer.subscriber.opted_in_at, data.customer.subscriber.optin_ip, data.cart, data.cart.id, data.cart.resource_id, data.cart.checkout_url, data.cart.cart_total, data.cart.items, data.cart.items[].id, data.cart.items[].product, data.cart.items[].product.id, data.cart.items[].product.name, data.cart.items[].product.price, data.cart.items[].product.url, data.cart.items[].product.image, data.cart.items[].product.exclude_from_automations, data.cart.items[].product.enabled, data.cart.items[].product.categories, data.cart.items[].product.categories[].id, data.cart.items[].product.categories[].name, data.cart.items[].product.categories[].exclude_from_automations, data.cart.items[].product.categories[].created_at, data.cart.items[].product.categories[].updated_at, data.cart.items[].variant, data.cart.items[].quantity, data.cart.items[].price, data.total, data.status, data.attribution, data.created_at, data.updated_at, data.completed_at.

    DELETE /api/ecommerce/shops/{shop_id}/orders/{order_id}

  • Destructive

    Create product variants

    If you want to create variants for the given product, send this POST request with an array of variants When any variant in the request has a resource_id , existing variants of the product whose resource_id is not in the request are deleted. Returns the product with its variants. Documented Parameter: Type: Required: Limitations: *.name: string: yes: The variant's name; *.attributes: object: yes: The variant's attributes, e.g. {"color": "Black"}; *.price_type: string: no: Either fixed or increment; *.price: float: no: The variant's price. Required when price_type is provided; *.resource_id: string: no: The variant's id in your shop. Used to update an existing variant; *.image_url: string: no: The variant's image url. Documented JSON-example fields (not a formal required-field schema): [].name, [].attributes, [].attributes.color, [].attributes.size, [].price, [].price_type, [].resource_id, [].image_url. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.enabled, data.short_description, data.description, data.categories, data.variants, data.variants[].id, data.variants[].name, data.variants[].attributes, data.variants[].attributes.color, data.variants[].attributes.size, data.variants[].price, data.variants[].price_type, data.variants[].resource_id, data.variants[].image_url. Documented JSON-example fields (not a formal required-field schema): message, errors, errors.0.name.

    POST /api/ecommerce/shops/{shop_id}/products/{product_id}/variants

  • Destructive

    Delete a product variant

    If you want to delete a variant of the given product, send this DELETE request Returns the product with its remaining variants, in the same format as Create product variants . If the shop, product or variant cannot be found: Documented Parameter: Type: Required: Limitations: shop_id: integer: yes: Must provide valid shop id; product_id: integer: yes: Must provide valid product id; variant_id: integer: yes: Must provide valid variant id. Primary response cross-reference to Create product variants returns the product with remaining variants; documented successful-response example fields from that referenced section: data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.enabled, data.short_description, data.description, data.categories, data.variants, data.variants[].id, data.variants[].name, data.variants[].attributes, data.variants[].attributes.color, data.variants[].attributes.size, data.variants[].price, data.variants[].price_type, data.variants[].resource_id, data.variants[].image_url.

    DELETE /api/ecommerce/shops/{shop_id}/products/{product_id}/variants/{variant_id}

  • Destructive

    Delete a product

    If you want to delete a product for the given shop, send this DELETE request Documented Parameter: Type: Required: Limitations: product_id: integer: yes: Must provide valid product id; shop_id: integer: yes: Must provide valid shop id. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.price, data.url, data.image, data.exclude_from_automations, data.enabled, data.short_description, data.description, data.categories, data.variants.

    DELETE /api/ecommerce/shops/{shop_id}/products/{product_id}

  • Destructive

    Delete a shop

    If you want to delete a shop, send this DELETE request If you try to delete the MailerLite shop: Documented Parameter: Type: Required: Limitations: id: integer: yes: Valid shop id for the account. Documented JSON-example fields (not a formal required-field schema): data, data.id, data.name, data.url, data.currency, data.enabled, data.enable_popups, data.group, data.group.id, data.group.name, data.group.total, data.group.open_rate, data.group.open_rate.float, data.group.open_rate.string, data.group.click_rate, data.group.click_rate.float, data.group.click_rate.string, data.group.created_at, data.created_at, data.updated_at, data.currency_sign.

    DELETE /api/ecommerce/shops/{id}

Subscriber import references

  • Write

    Create subscriber import

    The official getting-started Import rate limits section explicitly names this import-creation route and its separate 5 requests/minute limit. It does not provide the full request or response payload contract in this captured section; no required fields, completion or permission guarantee are invented.

    POST /api/subscribers/import

See How connections work for access and permissions, or browse all integrations.