![\"Emma](\"http://api.myemma.com/_images/api_key.png\")
Use the information on this page to set up and troubleshoot your API calls. If you are interested in paid API support, visit our Custom Integrations page and fill out a request. Our system is monitored around the clock – and if there’s ever a dropped connection or outage, we’ll be sure to notify users on our status page.
\nAll JSON payloads must not exceed 10MB
\nEmma’s platform is accessible through our public API, which provides access to the following areas:
\nEmma’s wrappers make it a breeze to connect to our API no matter which programming language you like to use. Just select your language and you’ll be able to integrate with Emma without the hassle of having to study all the ins and outs of our API first.
\nThis collection is young (but growing!) and includes wrappers commissioned by Emma as well as some built by members of our community. Unless otherwise noted, all wrappers provide full coverage of our current API. If you see something that needs to be fixed or improved, please don’t hesitate submit a pull request. And if you’ve built a wrapper that you’d like to have listed here, let us know!
\nLet’s get started by building some PHP code that will add a member to our audience.
\nFirst, you’ll want to figure out how to authenticate (all calls require HTTP Basic Auth authentication). You’ll find your API keys inside your Emma account in the “Account Settings” section. There’s a public key, a private key and an account ID. It should look like this:
\n
Next, let’s add these authentication bits to our code.
\n// Authentication Variables\n$account_id = \"xxx\";\n$public_api_key = \"xxx\";\n$private_api_key = \"xxx\";\nThen we’ll want to capture the POSTed form variables from the request.
\n// Form variable(s)\n$email = $_POST['email'];\n$first_name = $_POST['first_name'];\n$last_name = $_POST['last_name'];\n$groups = array(123456, 654321);\n\n// Member data other than email should be passed in an array called \"fields\"\n$member_data = array(\n \"email\" => $email,\n \"fields\" => array(\n \"first_name\" => $first_name,\n \"last_name\" => $last_name\n ),\n \"group_ids\" => $groups\n);\nPlease note that the group_ids hat you’re adding members to are passed as an array of integers. In addition, you’ll always want to make sure that you sanitize any of these form inputs to protect your application.
\nNow we’ll need to set the URL for the API call. The endpoint for all of our API calls is https://api.e2ma.net/. In this case, we’re using the endpoint that corresponds to adding a single member. There’s a separate call for adding bulk members.
\n// Set URL\n$url = \"https://api.e2ma.net/\".$account_id.\"/members/add\";\nNext, we’ll do a little dance with cURL that should look familiar to you. We’ll explain some particulars below the code block.
\n// setup and execute the cURL command\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_USERPWD, $public_api_key . \":\" . $private_api_key);\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_POST, count($member_data));\ncurl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($member_data));\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-type: application/json'));\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);\n$head = curl_exec($ch);\n$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);\ncurl_close($ch);\nLine 3 is where we use the public/private keys to authenticate our call. On lines 6-7, we force the API call to make its request in JSON and expect JSON in return.
\nAt this point, the API call has been made. We might also want to inspect the result to see what happened. The API returns true HTTP response codes that you can examine to determine a request’s disposition.
\n//execute post\nif($http_code > 200) {\n $app_message = \"Error sending subscription request\";\n} else {\n $app_message = \"Success!\";\n}\n\necho $app_message;\nYou can see the complete PHP script here. There’s also a PHP example to get members using their email address.
\nTo extend this example further, you could make the API call associate the new member with a particular signup form. As written above, the member would be added to the audience but would not appear in the “recent activity” type searches or really any searches related to signups. Don’t worry – we’re currently working on a cleaner way to handle this signup form issue in the future.
\nIn the following sections, we’ve organized API calls by their main entity type. Each call includes sample request and response data.
\nTo prevent accidental overuse, calls to Emma's API are limited to 180 calls per minute. If you exceed the limit, you‘ll receive a response of 403 Rate Limit Exceeded until enough time has elapsed between calls.
Responses with a large number of results should be paginated; the query parameters start and end can be used to specify how large a set of items to retrieve in each call, with a maximum page size of 500.
\nAdditionally, for any call you can retrieve a count of the results (instead of the results themselves) by appending a query parameter of count=true.
So, to pull a large number of results, you start with a count:
\nhttps://api.e2ma.net/123/members?count=true
\nThen, iterate over the list in blocks of 500:
\nhttps://api.e2ma.net/123/members?start=0&end=500
\nhttps://api.e2ma.net/123/members?start=500&end=1000
\nRequests for page sizes larger than 500 will limited to start + 500.
Calls are rate-limited to prevent accidental overuse. If you exceed the limit you will receive a response of 403 Rate Limit Exceeded until enough time has elapsed between calls.
The content of messages can be customized using the template tag library. Each template tag should be enclosed in a [% %] pair. Where a tag requires a qualifier value, the value should be attached with a colon.
\nFor example, the following extract shows a member’s name being inserted into a greeting:
\nHello [% member:first_name %] [% member:last_name %],\n\nWelcome to the \"Exciting Onions\" mailing list, where you can be kept up to\ndate on all the latest onion-related news ...\nSome tags also accept additional key/value pairs to control their behavior. For example, adding a default value to a member field:
\nHello [% member:first_name default=\"Friend\" %]\n...or specifying the link text for a trackable link:
\nPlease visit [% link:http://fancyonions.com/home name=\"our website\" %]\nTodo: fully document the available tags
\nSearches are constructed using nested JSON arrays of filters and boolean predicates. Here is an example of a simple filter:
\n[\"member_field:foo\", \"eq\", \"bar\"]\nA filter is composed of one or more parts. The first part is always a filter term. In general, a filter term maps directly to a field in the results. A filter term can accept an argument (the :foo in the example above) that will have different meanings for different filter terms. If the filter has more than one part, the second part is always an operator. The remaining parts are arguments for the operator. Different operators will have different arguments, but will always have at least one.
In addition, filters can be nested using boolean predicates. Here’s an example of a nested query:
\n[\"and\",\n [\"member_field:foo\", \"eq\", \"bar\"],\n [\"member_since\", \"in last\", {\"day\": 5}]]\nThis example will return all members who joined in the last 5 days and have their member_field foo set to bar. The available boolean predicates and examples of their use are below.
There are a bunch of operators available:
\neq and =: Basic equality. Example: [\"member_field:some_string_field\", \"eq\", \"bar\"]lt and <: Less than. Example: [\"member_field:some_numeric_field\", \"lt\", 5]gt and >: Greater than. Example: [\"member_field:some_numeric_field\", \"gt\", 5]between: Between. Takes two arguments. Example: [\"member_field:some_numeric_field\", \"between\", 5, 10]in last and in next: Relative date. Takes an interval (explained below). Example: [\"member_since\", \"in last\", {\"day\": 4}][\"member_since\", \"datematch\", {\"year\": 2011}]contains: Match a string against a shell-glob-style expression. Example: [\"member_field:some_string_field\", \"contains\", \"\\*foo\\*\"]in: Match a field against a list of values. Example: [\"member_field:some_number_field\", \"in\", 3, 4, 5, 6]any: Match a given value against an array field. Example: [\"member_field:some_array_field\", \"any\", \"ten\"]In addition to these basic operators, there is one advanced operator available:
\nzip-radius:n: where n can be one of 5, 10, 15, 20, 25, or 50. Takes a single zip code which will be the center of the search. Example: [\"member_field:some_zipcode_field\", \"zip-radius:10\", \"97202\"] will return all members with a zip_code_field within 10 miles of 97202.An interval is defined as a hash that contains one or more of the following keys:
\nyearmonthdayhourminutesecond{\"year\": 2, \"day\": 4} would specify an interval of two years and four days.A date is defined as a hash that contains one or more of the following keys:
\nyearmonthdayhourminuteseconddow (day of week){\"day\", 31} would match the 31st of every month with a 31st day, while {\"dow\": 2} would match every Tuesday. Sunday is 0.Boolean predicates operate on one or more nested clauses. These predicates are available:
\nand: All clauses must be true. Example: [\"and\", [\"member_field:foo\", \"eq\", 1], [\"member_field:bar\", \"eq\", 2]]or: At least one clause must be true. Example: [\"or\", [\"member_field:foo\", \"eq\", 1], [\"member_field:bar\", \"eq\", 2]]not: The single nested clause must not be true. Example: [\"not\", [\"member_field:foo\", \"eq\", 1]]In general, every key in the result records can be used as a filter term. Just use the key as the filter term. For example, to filter on send_start, you’d say [\"send_start\", \"gt\", \"2011-12-15\"]. In addition, there is a large set of advanced filter terms for filtering members:
opened, clicked, shared, forwarded. Will match on the timestamp of the corresponding response if it exists. All of these filter terms also allow a mailing_id as an argument (i.e. opened:12345 matches if they opened mailing 12345.member_field:x where x is the short name of a member field. You can also use x by itself without member_field:.group. Will match the name of a member group. Takes the special operators defined (belongs to any group) and undefined (does not belong to any group).received Will match if the member received a mailing. Takes an optional mailing_id argument. If not given, will match if the member has received any mailing.clicked link. Will match if the member has clicked on a link. Takes an optional link_id argument. If not given, will match if the member has clicked on any link.manage: Will match if the member has manged their preferences. Optionally takes a date filter on the timestamp of the manage action. Optionally takes a signup_form_id argument. Example: [\"manage:1234\", \"in last\", {\"day\", 30}].unsubscribed: Will match if the member has unsubscribed. Optionally takes a date filter on the timestamp of the opt-out action. Optionally takes a signup_form_id filter argument.unsubscribed mailing: Will match if the member has - unsubscribed. Optionally takes a date filter on the timestamp of the opt-out action. Optionally takes a mailing_id filter argument.bounced: Will match if the member had either a soft or hard bounce. Optionally takes a date filter on the timestamp of the bounce. Optionally takes a mailing_id filter argument.email_user: Will match on the user portion of the member’s email addressemail_domain: Will match on the domain portion of the member’s email addressemail: Will match on the member’s entire email addresssignup: Will match if the member has signed up. Optionally takes a date filter on the timestamp of the signup action. Optionally takes a signup_form_id filter argument.signup_mailing: Will match if the member has signed up. Optionally takes a date filter on the timestamp of the signup action. Optionally takes a mailing_id filter argument.Webhooks are an easy way to have Emma’s system notify you when certain events occur. In general, you will use our API to tell us which events you want to be notified about. When those events occur, we will make a POST to the URL you have provided with a particular set of data.
\nWe have a broad array of triggering events and an easy API interface to create webhooks for each event. We do have [documentation of the webhook API](documentation of the webhook API).
\nBelow is a list of each triggering event we currently support and the data that will be sent when that event occurs.
\n{\n \"event_name\": \"member_signup\",\n \"data\": {\n \"account_id\": account_id,\n \"member_id\": member_id,\n \"mailing_id\": mailing_id\n }\n}\n{\n \"event_name\": \"message_open\",\n \"data\": {\n \"account_id\": account_id,\n \"member_id\": member_id,\n \"mailing_id\": mailing_id,\n \"subject\": mailing_subject,\n \"timestamp\": timestamp\n }\n}\n{\n \"event_name\": \"message_click\",\n \"data\": {\n \"account_id\": account_id,\n \"member_id\": member_id,\n \"mailing_id\": mailing_id,\n \"subject\": mailing_subject,\n \"timestamp\": timestamp,\n \"link_id\": link_id\n }\n}\n{\n \"event_name\": \"member_optout\",\n \"data\": {\n \"account_id\": account_id,\n \"member_id\": member_id,\n \"mailing_id\": mailing_id,\n \"subject\": mailing_subject,\n \"timestamp\": timestamp\n }\n}\n{\n \"event_name\": \"message_share\",\n \"data\": {\n \"account_id\": account_id,\n \"member_id\": member_id,\n \"mailing_id\": mailing_id,\n \"subject\": mailing_subject,\n \"timestamp\": timestamp,\n \"network\": network_code\n }\n}\n{\n \"event_name\": \"message_share_click\",\n \"data\": {\n \"account_id\": account_id,\n \"member_id\": member_id,\n \"mailing_id\": mailing_id,\n \"subject\": mailing_subject,\n \"timestamp\": timestamp,\n \"network\": network_code\n }\n}\n{\n \"event_name\": \"message_forward\",\n \"data\": {\n \"account_id\": account_id,\n \"member_id\": member_id,\n \"mailing_id\": mailing_id,\n \"subject\": mailing_subject,\n \"timestamp\": timestamp\n }\n}\n{\n \"event_name\": \"mailing_finish\",\n \"data\": {\n \"mailing_id\": mailing_id,\n \"account_id\": account_id,\n \"subject\": mailing_subject,\n \"timestamp\": timestamp\n }\n}\n{\n \"event_name\": \"import_finish\",\n \"data\": {\n \"import_id\": import_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"member_add\",\n \"data\": {\n \"member_id\": member_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"signup_form_id\": signup_form_id,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"member_update\",\n \"data\": {\n \"member_id\": member_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp\n }\n}\n{\n \"event_name\": \"member_delete\",\n \"data\": {\n \"member_id\": member_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp\n }\n}\nIt’s possible that instead of an array for member_ids or group_ids you may receive a string with the text all. Because of calls that can add a member to all groups or add all members to a single group, this is easier than returning a giant list of IDs.
{\n \"event_name\": \"member_add_to_group\",\n \"data\": {\n \"member_ids\": {member_ids},\n \"account_id\": account_id,\n \"timestamp\": timestamp.\n \"group_ids\": {group_ids}\n }\n}\nIt’s possible that instead of an array for member_ids or group_ids you may receive a string with the text all. Because of calls that can remove a member from all groups or remove all members from a single group, this is easier than returning a giant list of IDs.
{\n \"event_name\": \"member_remove_from_group\",\n \"data\": {\n \"member_ids\": {member_ids},\n \"account_id\": account_id,\n \"timestamp\": timestamp.\n \"group_ids\": {group_ids}\n }\n}\n{\n \"event_name\": \"group_create\",\n \"data\": {\n \"group_id\": group_id,\n \"group_name\": group_name,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"group_delete\",\n \"data\": {\n \"group_id\": group_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"group_update\",\n \"data\": {\n \"group_id\": group_id,\n \"group_name\": group_name,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"field_create\",\n \"data\": {\n \"field_id\": field_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"field_delete\",\n \"data\": {\n \"field_id\": field_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"field_update\",\n \"data\": {\n \"field_id\": field_id,\n \"account_id\": account_id,\n \"timestamp\": timestamp,\n \"resource_url\": resource_url\n }\n}\n{\n \"event_name\": \"member_status_update\",\n \"data\": {\n \"member_ids\": {member_ids},\n \"account_id\": account_id,\n \"new_status\": new_status,\n \"timestamp\": timestamp\n }\n}\nConverts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/events","description":"This endpoint allows you to post any type of valid JSON to Emma. In order for an event to power an automated workflow, the following conditions must be met:
\nemailActive status within your audienceThe Emma Event API is used to automate and personalize emails that are triggered by audience activities in other platforms. While it is often used to power automated workflows triggered by activities like purchases and event registration and attendance, the Event API can receive events and data of any type from any service.
\nYou can post events to Emma using the endpoint below. Workflows that are triggered by events shared to this endpoint can be configured in the Automation workflow builder. For more information about the event API and its capabilities, visit our Resource Center.
\n","_postman_id":"7901b763-27ce-1ea7-6e42-3f77f1cf12ae"},{"name":"Fields","item":[{"name":"Get All Fields","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["",""]}}],"id":"fab3eceb-b282-7749-fa77-5ae1b545a549","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields","description":"Gets a list of this account’s defined fields.
\nParameters:
\nReturns: An array of fields.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","fields"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"12c99436-40ce-ea76-c113-9ca9582a1b8f","name":"Sample Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"3625","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 28 Jun 2017 02:35:40 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=300, max=9997","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)","name":"Server","description":""},{"key":"accept-ranges","value":"bytes","name":"accept-ranges","description":""},{"key":"age","value":"33","name":"age","description":""},{"key":"connection","value":"keep-alive, Keep-Alive","name":"connection","description":""},{"key":"via","value":"1.1 varnish-v4","name":"via","description":""},{"key":"x-varnish","value":"12175473 1765157","name":"x-varnish","description":""}],"cookie":[],"responseTime":"167","body":"[\n {\n \"shortcut_name\": \"first_name\",\n \"display_name\": \"First Name\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 200,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 1,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"last_name\",\n \"display_name\": \"Last Name\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 201,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 2,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"favorite_food\",\n \"display_name\": \"Favorite Food\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 202,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 3,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"birthday\",\n \"display_name\": \"Birthday\",\n \"account_id\": 100,\n \"field_type\": \"date\",\n \"required\": false,\n \"field_id\": 203,\n \"widget_type\": \"date\",\n \"short_display_name\": null,\n \"column_order\": 4,\n \"deleted_at\": null,\n \"options\": null\n }\n]"},{"id":"5567c977-692a-df2d-dc66-9c6bdf3915b4","name":"Get All Fields","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"shortcut_name\": \"first_name\",\n \"display_name\": \"First Name\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 200,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 1,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"last_name\",\n \"display_name\": \"Last Name\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 201,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 2,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"favorite_food\",\n \"display_name\": \"Favorite Food\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 202,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 3,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"birthday\",\n \"display_name\": \"Birthday\",\n \"account_id\": 100,\n \"field_type\": \"date\",\n \"required\": false,\n \"field_id\": 203,\n \"widget_type\": \"date\",\n \"short_display_name\": null,\n \"column_order\": 4,\n \"deleted_at\": null,\n \"options\": null\n }\n]\n"},{"id":"7ad37127-e846-d1b6-457e-89957d03ae6d","name":"Sample Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","name":"Authorization","value":"Basic ODJjMGZjMDZjZDVkNWY2YTRkYmI6NWRlMjZhZTc3NTZiZmNlZGE1ZWQ="}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"3625","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 28 Jun 2017 02:35:40 GMT","name":"Date","description":""},{"key":"Keep-Alive","value":"timeout=300, max=9997","name":"Keep-Alive","description":""},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)","name":"Server","description":""},{"key":"accept-ranges","value":"bytes","name":"accept-ranges","description":""},{"key":"age","value":"33","name":"age","description":""},{"key":"connection","value":"keep-alive, Keep-Alive","name":"connection","description":""},{"key":"via","value":"1.1 varnish-v4","name":"via","description":""},{"key":"x-varnish","value":"12175473 1765157","name":"x-varnish","description":""}],"cookie":[],"responseTime":"167","body":"[\n {\n \"shortcut_name\": \"first_name\",\n \"display_name\": \"First Name\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 200,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 1,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"last_name\",\n \"display_name\": \"Last Name\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 201,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 2,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"favorite_food\",\n \"display_name\": \"Favorite Food\",\n \"account_id\": 100,\n \"field_type\": \"text\",\n \"required\": false,\n \"field_id\": 202,\n \"widget_type\": \"text\",\n \"short_display_name\": null,\n \"column_order\": 3,\n \"deleted_at\": null,\n \"options\": null\n },\n {\n \"shortcut_name\": \"birthday\",\n \"display_name\": \"Birthday\",\n \"account_id\": 100,\n \"field_type\": \"date\",\n \"required\": false,\n \"field_id\": 203,\n \"widget_type\": \"date\",\n \"short_display_name\": null,\n \"column_order\": 4,\n \"deleted_at\": null,\n \"options\": null\n }\n]"}],"_postman_id":"fab3eceb-b282-7749-fa77-5ae1b545a549"},{"name":"Get Field By Id","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["",""]}}],"id":"c6bd0a97-0ac6-9eb0-a1b4-3caaf638397b","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields/#field_id","description":"Gets the detailed information about a particular field.
\nParameters:
\nReturns: A field.
\nRaises: Http404 if the field does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shortcut_name\": \"new_boolean\", \n \"column_order\": 3, \n \"display_name\": \"A New Boolean Field\", \n \"field_type\": \"boolean\"\n \"widget_type\": \"boolean\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/fields","description":"Create a new field field.
\nThere must not already be a field with this name.
\nParameters:
\ntext, long, checkbox, select multiple, check_multiple, radio, date, select one, number.Returns: A reference to the new field.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","fields"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"000a5dcc-dd39-a31c-f71c-773adc76b0c1","name":"Create New Field","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shortcut_name\": \"new_boolean\", \n \"column_order\": 3, \n \"display_name\": \"A New Boolean Field\", \n \"field_type\": \"boolean\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"1024"}],"_postman_id":"6682bc20-2e9d-cf6a-13d8-092c385690fc"},{"name":"Delete Field","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["",""]}}],"id":"effbb485-7049-5d0f-fc9b-1b8c4a7e9b16","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields/#field_id","description":"Deletes a field.
\nReturns: True if the field is deleted, False otherwise.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","fields",""],"hash":"field_id","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"e9121954-6b97-4d0a-90f6-92d043448ae3","name":"Delete A Field","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields/200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"true"}],"_postman_id":"effbb485-7049-5d0f-fc9b-1b8c4a7e9b16"},{"name":"Clear Field Member Data","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["",""]}}],"id":"750269ea-dd74-3d9f-f1e3-3f6793cd6536","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/fields/#field_id/clear","description":"Clear the member data for the specified field.
\nReturns: True if all of the member field data is deleted.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","fields",""],"hash":"field_id/clear","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"795b2ef7-b01c-e23e-c6f5-366df1182a32","name":"Clear Member Data For A Field","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"raw","raw":"{}"},"url":"https://api.e2ma.net/{{account_id}}/fields/200/clear"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"true"}],"_postman_id":"750269ea-dd74-3d9f-f1e3-3f6793cd6536"},{"name":"Update Field","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["",""]}}],"id":"14d4e342-5afa-fdf3-abf8-ceb04535b1a5","request":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/fields/#field_id","description":"Updates an existing field.
\nReturns: A reference to the updated field.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","fields",""],"hash":"field_id","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"2bab3ff5-515d-2c6f-febc-2cbd83a58bed","name":"Update A Field","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/fields/202"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"373","body":"{\n \"display_name\": \"Your Birthday\"\n}"}],"_postman_id":"14d4e342-5afa-fdf3-abf8-ceb04535b1a5"}],"id":"52b9b74c-830b-d99b-189a-86b9117583c7","description":"These endpoints let you create, edit, update and delete all of the custom fields in your account. Of particular interest is the /#account_id/fields/#field_id/clear endpoint which lets you clear out all the data in a single field for all members in your account. This makes it easy to re-initialize a dataset if you’re looking to correct an import error or syncing issue.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/groups","description":"Get a basic listing of all active member groups for a single account.
\nReturns: An array of groups.
\nParameters:
\ng): g (group)t (test)h (hidden)all (all)Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"groups\": [\n {\n \"group_name\": \"My Grp\"\n }\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/groups","description":"Create one or more new member groups.
\nReturns: An array of the new group ids and group names.
\nParameters:
\ngroup_name parameter.Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id","description":"Get the detailed information for a single member group.
\nReturns: A group.
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"New Group Name\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id","description":"Update information for a single member group.
\nParameters:
\nReturns: True if the update was successful
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id","description":"Delete a single member group.
\nReturns: True if the group is deleted.
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id/members","description":"Get the members in a single active member group.
\nReturns: An array of members.
\nParameters:
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"member_ids\": [\n 202\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id/members","description":"Add a list of members to a single active member group.
\nParameters:
\nReturns: An array of references to the members added to the group. If a member already exists in the group or is not a valid member, that reference will not be returned.
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"member_ids\": [\n 200, \n 201\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id/members/remove","description":"Remove members from a single active member group.
\nParameters:
\nReturns: An array of references to the removed members.
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id/members","description":"Remove all members from a single active member group.
\nParameters:
\na (active)o (optout)e (error)Returns: The number of members removed from the group.
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/groups/#member_group_id/members/remove","description":"Delete all members in this group with the specified status. Remove those members from all groups as a background job. The member_status_id parameter must be set.
Parameters:
\na (active)o (optout)e (error)Returns: True.
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/groups/#from_group_id/#to_group_id/members/copy","description":"Copy all the users of one group into another group.
\nParameters:
\na (active)o (optout)e (error)Returns: True.
\nRaises: Http404 if the group does not exist.
With these endpoints, you can manage all aspects of the groups in your account. In addition to various CRUD methods, you can also use these endpoints to manage the members of your groups. You’ll want to use these methods if you’re managing group membership for more than one member at a time. For dealing with single members, there are better methods in the members endpoints.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings","description":"Get information about current mailings.
\nParameters:
\nm,t, standard and test mailings, when none are specified.: m (standard)t (test)r (trigger)s (split)p,a,s,x,c,u,f, all statuses, when none are specified:p (pending)a (paused)s (sending)x (canceled)c (complete)u (unapproved)f (failed)Raises: Http400 if invalid mailing types or statuses are specified.
Returns: An array of mailings.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","mailings"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"636aa751-d9b0-792a-b90a-0fd73fe47576","name":"Get All Mailings","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"\n[\n {\n \"mailing_type\": \"m\",\n \"send_started\": null,\n \"cancel_by_user_id\": null,\n \"mailing_id\": 201,\n \"recipient_count\": 0,\n \"cancel_ts\": null,\n \"mailing_status\": \"p\",\n \"month\": null,\n \"failure_ts\": null,\n \"reply_to\": null,\n \"year\": null,\n \"datacenter\": null,\n \"started_or_finished\": null,\n \"account_id\": 100,\n \"disabled\": false,\n \"created_ts\": \"@D:2013-08-22T09:41:45\",\n \"sender\": \"Kevin McConnell\",\n \"plaintext_only\": false,\n \"name\": \"Cancellable mailing\",\n \"parent_mailing_id\": null,\n \"failure_message\": null,\n \"send_finished\": null,\n \"send_at\": null,\n \"signup_form_id\": null,\n \"subject\": \"Cancellable mailing\",\n \"purged_at\": null,\n \"archived_ts\": null\n },\n {\n \"mailing_type\": \"m\",\n \"send_started\": null,\n \"cancel_by_user_id\": null,\n \"mailing_id\": 200,\n \"recipient_count\": 0,\n \"cancel_ts\": null,\n \"mailing_status\": \"c\",\n \"month\": null,\n \"failure_ts\": null,\n \"reply_to\": null,\n \"year\": null,\n \"datacenter\": null,\n \"started_or_finished\": null,\n \"account_id\": 100,\n \"disabled\": false,\n \"created_ts\": \"@D:2013-08-22T09:41:45\",\n \"sender\": \"Kevin McConnell\",\n \"plaintext_only\": false,\n \"name\": \"Sample Mailing\",\n \"parent_mailing_id\": null,\n \"failure_message\": null,\n \"send_finished\": null,\n \"send_at\": null,\n \"signup_form_id\": null,\n \"subject\": \"Sample Mailing for [% member:first_name %] [% member:last_name %]\",\n \"purged_at\": null,\n \"archived_ts\": null\n }\n]"},{"id":"bf404b9e-5c07-501a-f6a1-1c131c841350","name":"status = pending, complete AND type = standard, test","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.e2ma.net/{{account_id}}/mailings?mailing_statuses=p,c&mailing_types=m,t","protocol":"https","host":["api","e2ma","net"],"path":["{{account_id}}","mailings"],"query":[{"key":"mailing_statuses","value":"p,c"},{"key":"mailing_types","value":"m,t"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"mailing_type\": \"m\",\n \"send_started\": null,\n \"cancel_by_user_id\": null,\n \"mailing_id\": 201,\n \"recipient_count\": 0,\n \"cancel_ts\": null,\n \"mailing_status\": \"p\",\n \"month\": null,\n \"failure_ts\": null,\n \"reply_to\": null,\n \"year\": null,\n \"datacenter\": null,\n \"started_or_finished\": null,\n \"account_id\": 100,\n \"disabled\": false,\n \"created_ts\": \"@D:2013-08-22T09:41:45\",\n \"sender\": \"Kevin McConnell\",\n \"plaintext_only\": false,\n \"name\": \"Cancellable mailing\",\n \"parent_mailing_id\": null,\n \"failure_message\": null,\n \"send_finished\": null,\n \"send_at\": null,\n \"signup_form_id\": null,\n \"subject\": \"Cancellable mailing\",\n \"purged_at\": null,\n \"archived_ts\": null\n },\n {\n \"mailing_type\": \"m\",\n \"send_started\": null,\n \"cancel_by_user_id\": null,\n \"mailing_id\": 200,\n \"recipient_count\": 0,\n \"cancel_ts\": null,\n \"mailing_status\": \"c\",\n \"month\": null,\n \"failure_ts\": null,\n \"reply_to\": null,\n \"year\": null,\n \"datacenter\": null,\n \"started_or_finished\": null,\n \"account_id\": 100,\n \"disabled\": false,\n \"created_ts\": \"@D:2013-08-22T09:41:45\",\n \"sender\": \"Kevin McConnell\",\n \"plaintext_only\": false,\n \"name\": \"Sample Mailing\",\n \"parent_mailing_id\": null,\n \"failure_message\": null,\n \"send_finished\": null,\n \"send_at\": null,\n \"signup_form_id\": null,\n \"subject\": \"Sample Mailing for [% member:first_name %] [% member:last_name %]\",\n \"purged_at\": null,\n \"archived_ts\": null\n }\n]"}],"_postman_id":"c87ed266-0652-ed9c-0ffc-ad2a57f7b573"},{"name":"Get Mailing by Id","id":"f8df98d8-85d1-6364-bfae-bca0b2fd1745","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id","description":"Get detailed information for one mailing.
\nReturns: A mailing.
\nRaises: Http404 if no mailing is found.
Hello [% member:first_name %]!
\"\n}"}],"_postman_id":"f8df98d8-85d1-6364-bfae-bca0b2fd1745"},{"name":"Get Mailing Members","id":"675a4a48-2c66-fb16-b804-d3f49bcc52be","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id/members","description":"Get the list of members to whom the given mailing was sent. This does not include groups or searches.
\nReturns: An array of members including status and member fields.
\nRaises: Http404 if no mailing is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id/messages/#member_id","description":"Gets the personalized message content as sent to a specific member as part of the specified mailing.
\nParameters:
\nall, html, plaintext, subject. Defaults to all, if not provided.Returns: Message content from a mailing, personalized for a member. The response will contain all parts of the mailing content by default, or just the type of content specified by type.
Raises: Http404 if no message is found.
Hello !
\"\n}"},{"id":"95d5d03f-7d4d-c861-9ba4-fb36fc071850","name":"Get Personalized Mailing Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/200/messages/200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"plaintext\": \"Hello !\", \n \"subject\": \"Sample Mailing for \", \n \"html_body\": \"Hello !
\"\n}"}],"_postman_id":"865c8a0a-c55b-d129-0ea0-3d28086ee57e"},{"name":"Get Mailing Groups","id":"b02ae677-4e7c-2642-c13d-6b92487b957b","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id/groups","description":"Get the groups to which a particular mailing was sent.
\nReturns: An array of groups.
\nRaises: Http404 if no mailing is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id/searches","description":"Get all searches associated with a sent mailing.
\nReturns: An array of searches.
\nRaises: Http404 if no mailing is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id","description":"Update status of a current mailing
\nThe status can be one of canceled, paused or ready. This method can be used to control the progress of a mailing by pausing, canceling or resuming it. Once a mailing is canceled it can’t be resumed, and will not show in the normal mailing_list output.
Returns: The mailing’s new status
\n","urlObject":{"protocol":"https","path":["{{account_id}}","mailings",""],"hash":"mailing_id","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[],"_postman_id":"49d2f7ec-c8d3-480d-dcfa-ad7a679d2681"},{"name":"Delete Mailing","id":"7c6ebd3e-b2e8-31d4-2af2-5e3266b59b42","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id","description":"Sets archived timestamp for a mailing so it is no longer included in mailing_list.
Returns: True if the mailing is successfully archived.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","mailings",""],"hash":"mailing_id","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"eec6fcca-ee6b-9c85-c7a2-159ad5dffea2","name":"Delete A Mailing","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/200"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"true"}],"_postman_id":"7c6ebd3e-b2e8-31d4-2af2-5e3266b59b42"},{"name":"Delete Pending or Paused Mailing","id":"12279b03-bc10-7fe5-106d-2d9893433573","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/cancel/#mailing_id","description":"Cancels a mailing that has a current status of pending or paused
\nReturns: True if mailing marked as cancelled.
\nRaises: HTTP404 for all other statuses
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/forwards/#mailing_id/#member_id","description":"Forward a previous message to additional recipients. If these recipients are not already in the audience, they will be added with a status of FORWARDED.
Parameters:
\nReturns: A reference to the new mailing.
\nRaises: Http404 if no message is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id","description":"Send a prior mailing to additional recipients. A new mailing will be created that inherits its content from the original.
\nParameters:
\nReturns: A reference to the new mailing.
\nRaises: Http404 if no mailing is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id/headsup","description":"Get heads up email address(es) related to a mailing.
\nReturns: An array of heads up email addresses.
\nRaises: Http404 if no mailing is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/validate","description":"Validate that a mailing has valid personalization-tag syntax. Checks tag syntax in three params:
\nParameters:
\ncreate_mailing, this param is not required.Returns: true
\nRaises: Http400 if any tags are invalid. The response body will have information about the invalid tags.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/mailings/#mailing_id/winner/#winner_id","description":"Declare the winner of a split test manually. In the event that the test duration has not elapsed, the current stats for each test will be frozen and the content defined in the user declared winner will sent to the remaining members for the mailing. Please note, any messages that are pending for each of the test variations will receive the content assigned to them when the test was initially constructed.
\nReturns: True on sucess.
\nRaises: Http403 if the winner cannot be manually declared.
With these endpoints, you can get information about your mailings including their HTML contents. You can retrieve the members to whom the mailing was sent. You can also pause mailings and cancel mailings that are pending or paused.
\n","_postman_id":"f3c5715d-c8f6-40bc-5bad-e0697d22709a"},{"name":"Members","item":[{"name":"Get Members","id":"5690f19b-a95f-1c49-8dbf-73ed4e141920","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members","description":"Get a basic listing of all members in an account.
\nParameters:
\nReturns: A list of members in the given account.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"89e5fcb9-4c31-e29e-816b-b399fa432dc9","name":"Include Deleted Members?start=2&end=4&deleted=true","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"status\": \"active\",\n \"confirmed_opt_in\": null,\n \"account_id\": 100,\n \"fields\": {\n \"first_name\": \"Tony\",\n \"last_name\": \"Brown\",\n \"favorite_food\": \"pizza\"\n },\n \"member_id\": 202,\n \"last_modified_at\": null,\n \"member_status_id\": \"a\",\n \"plaintext_preferred\": false,\n \"email_error\": null,\n \"member_since\": \"@D:2010-11-12T09:12:33\",\n \"bounce_count\": 0,\n \"deleted_at\": null,\n \"email\": \"tony@myemma.com\"\n },\n {\n \"status\": \"active\",\n \"confirmed_opt_in\": null,\n \"account_id\": 100,\n \"fields\": {\n\n },\n \"member_id\": 203,\n \"last_modified_at\": null,\n \"member_status_id\": \"a\",\n \"plaintext_preferred\": false,\n \"email_error\": null,\n \"member_since\": \"@D:2011-01-01T00:00:00\",\n \"bounce_count\": 0,\n \"deleted_at\": \"@D:2011-01-02T10:27:43\",\n \"email\": \"greg@myemma.com\"\n }\n]\n"},{"id":"bf9f5247-ab2b-98a9-c8d1-3c653e1cd419","name":"Get Members 0-2","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.e2ma.net/{{account_id}}/members?start=0&end=2","protocol":"https","host":["api","e2ma","net"],"path":["{{account_id}}","members"],"query":[{"key":"start","value":"0"},{"key":"end","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"status\": \"active\",\n \"confirmed_opt_in\": null,\n \"account_id\": 100,\n \"fields\": {\n \"first_name\": \"Emma\",\n \"last_name\": \"Smith\",\n \"favorite_food\": \"tacos\"\n },\n \"member_id\": 200,\n \"last_modified_at\": null,\n \"member_status_id\": \"a\",\n \"plaintext_preferred\": false,\n \"email_error\": null,\n \"member_since\": \"@D:2010-11-12T11:23:45\",\n \"bounce_count\": 0,\n \"deleted_at\": null,\n \"email\": \"emma@myemma.com\"\n },\n {\n \"status\": \"opt-out\",\n \"confirmed_opt_in\": null,\n \"account_id\": 100,\n \"fields\": {\n \"first_name\": \"Gladys\",\n \"last_name\": \"Jones\",\n \"favorite_food\": \"toast\"\n },\n \"member_id\": 201,\n \"last_modified_at\": null,\n \"member_status_id\": \"o\",\n \"plaintext_preferred\": false,\n \"email_error\": null,\n \"member_since\": \"@D:2011-01-03T15:54:13\",\n \"bounce_count\": 0,\n \"deleted_at\": null,\n \"email\": \"gladys@myemma.com\"\n }\n]\n"}],"_postman_id":"5690f19b-a95f-1c49-8dbf-73ed4e141920"},{"name":"Get Member By Id","id":"06206aea-fd7c-8574-03bd-504ea5047fab","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id","description":"Get detailed information on a particular member, including all custom fields.
\nParameters:
\nReturns: A single member if one exists.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/email/#email","description":"Get detailed information on a particular member, including all custom fields, by email address instead of ID.
\nParameters:
\nReturns: A single member if one exists.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id/optout","description":"If a member has been opted out, returns the details of their optout, specifically date and mailing_id.
Returns: Member opt out date and mailing if member is opted out.
\nRaises: Http4041 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}"},"url":"https://api.e2ma.net/{{account_id}}/members/email/optout/#email","description":"Update a member’s status to optout keyed on email address instead of an ID.
\nReturns: True if member status change was successful or member was already opted out.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"email\": \"michelle@myemma.com\"\n },\n {\n \"email\": \"nathan@myemma.com\"\n }\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members","description":"Add new members or update existing members in bulk. If you are doing actions for a single member please see the /members/add call below.
Parameters:
\nemail. All other fields are treated as the name of a member field.Returns: An import id.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"d166cae4-7848-bde4-8a88-c156006d08fa","name":"Add Multiple Members","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"email\": \"michelle@myemma.com\"\n },\n {\n \"email\": \"nathan@myemma.com\"\n }\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"import_id\": 1024\n}"}],"_postman_id":"5278f208-ff2c-bdee-56dd-bdbed44dcdae"},{"name":"Add Member","id":"4a1ef7a2-4dbd-989e-f10a-33c4bbd360cb","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields\": {\n \"first_name\": \"Benjamin\"\n },\n \"email\": \"benjamin@myemma.com\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/add","description":"Adds or updates a single audience member. If you are performing actions on bulk members please use the /members call above.
Note: Members who are added to your audience using this API call will\nnot appear in recent activity searches within your account.
Note: If you are using Signup trigger events in Automation, please see this guide for\nmore information on how this API call affects those trigger events.
\nParameters:
\nReturns: The member_id of the new or updated member, whether the member was added or an existing member was updated, and the status of the member. The status will be reported as a (active), e (error), or o (optout).
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields\": {\n \"first_name\": \"Ryan\"\n },\n \"group_ids\": [\n \"1\",\n \"2\"\n ],\n \"email\": \"example@myemma.com\",\n \"signup_form_id\": 1,\n \"opt_in_confirmation\": true\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/signup","description":"Takes the necessary actions to signup a member and enlist them in the provided group ids. You can send the same member multiple times and pass in new group ids to signup.
\nThis process triggers the opt-out workflow, and will send a mailing to the member on new group enlistments. If no new group ids are provided for an existing member, the endpoint will respond back with their status and member_id, performing no additional actions.
Note: Members who are added to your audience using this API call will not appear in recent activity searches within your account.
Note: If you are using Signup trigger events in Automation, please see this guide for more information on how this API call affects those trigger events.
\nParameters:
\n[rsvp_name], [rsvp_email], [opt_in_url], [opt_out_url].Returns: The member_id of the new or updated member, whether the member was added or an existing member was updated, and the status of the member. The status will be reported as a (active), e (error), or o (optout).
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"member_ids\": [\n 100,\n 101\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/delete","description":"Delete an array of members.
\nThe members will be marked as deleted and cannot be retrieved.
\nParameters:
\nReturns: True if all members are successfully deleted, otherwise False.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members","delete"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"ce293059-9127-2264-492d-60bc40013140","name":"Delete Multiple Members","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"member_ids\": [\n 100,\n 101\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"true"}],"_postman_id":"719be006-8ea7-def4-9e7d-c934a62bb8f8"},{"name":"Change Member Status","id":"08f890d5-37a6-7f11-15a4-91f5c408f559","request":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"member_ids\": [\n 200,\n 202\n ],\n \"status_to\": \"e\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/status","description":"Change the status for an array of members.
\nThe members will have their member_status_id updated.
Parameters:
\na (active)e (error)o (optout)Returns: True if the members are successfully updated, otherwise False.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members","status"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"99aa20e4-534d-860b-e9e1-56da0af3fe0b","name":"Change Multiple Member Statuses","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"member_ids\": [\n 200,\n 202\n ],\n \"status_to\": \"e\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"true"}],"_postman_id":"08f890d5-37a6-7f11-15a4-91f5c408f559"},{"name":"Update Member","id":"076f6b78-cb38-7e0b-eb84-5f52d9ee54a2","request":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields\": {\n \"first_name\": \"Ella\",\n \"last_name\": \"Jones\"\n },\n \"email\": \"ella@myemma.com\",\n \"status_to\": \"a\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id","description":"Update a single member’s information.
\nUpdate the information for an existing member (even if they are marked as deleted). Note that this method allows the email address to be updated (which cannot be done with a POST, since in that case the email address is used to identify the member).
\nParameters:
\na (active)e (error)o (opt-out).true.Returns: True if the member was updated successfully
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id","description":"Delete the specified member.
\nThe member, along with any associated response and history information, will be completely removed from the database.
\nReturns: True if the member is deleted.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id/groups","description":"*Get the groups to which a member belongs.
\nReturns: An array of groups.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_ids\": [\n 150,\n 151\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id/groups","description":"Add a single member to one or more groups.
\nParameters:
\nReturns: An array of ids of the affected groups.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_ids\": [\n 151\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id/groups/remove","description":"Remove a single member from one or more groups.
\nParameters:
\nReturns: An array of ids of the affected groups.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/members","description":"Delete all members.
\nParameters:
\na (active)o (optout)e (error)Returns: Returns true.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"1bc4d942-67c7-854d-dd90-c7b980cbf0ce","name":"Delete Members With A Status of 'Error'","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.e2ma.net/{{account_id}}/members?member_status_id=e","protocol":"https","host":["api","e2ma","net"],"path":["{{account_id}}","members"],"query":[{"key":"member_status_id","value":"e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"true"}],"_postman_id":"752ff38c-6372-2477-bff4-b686a4ce9a75"},{"name":"Remove Member From All Groups","id":"f1559261-9290-d3e7-75f8-9ee66807c5f1","request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id/groups","description":"Remove the specified member from all groups.
\nReturns: True if the member is removed from all groups.
\nRaises: Http404 if no member is found.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_ids\": [\n 151\n ],\n \"member_ids\": [\n 202\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/groups/remove","description":"Remove multiple members from groups.
\nParameters:
\nReturns: True if the members are removed, otherwise False.\n.
\nRaises: Http404 if any of the members or groups do not exist.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/#member_id","description":"Get the entire mailing history for a member.
\nReturns: Message history details for the specified member.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members",""],"hash":"member_id","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"d54dc9f7-9a49-36e8-e8ba-13d8e568e18a","name":"Get A Member's Maling History","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/200/mailings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"delivery_type\": \"d\",\n \"clicked\": \"@D:2011-01-02T11:14:32\",\n \"opened\": \"@D:2011-01-02T11:13:51\",\n \"mailing_id\": 200,\n \"delivery_ts\": \"@D:2011-01-02T10:29:36\",\n \"name\": \"Sample Mailing\",\n \"forwarded\": null,\n \"shared\": null,\n \"subject\": \"Sample Mailing for [% member:first_name %] [% member:last_name %]\",\n \"sent\": \"@D:2011-01-02T10:27:43\",\n \"account_id\": 100\n }\n]"}],"_postman_id":"cca58d77-30c9-c600-8f27-8b39855b4110"},{"name":"Get Members In Import","id":"334efd73-2913-aee2-1fd8-f1763251805b","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/imports/#import_id/members","description":"Get a list of members affected by this import.
\nReturns: A list of members in the given account and import.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members","imports",""],"hash":"import_id/members","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"1553614b-227a-542c-351f-cad58794056c","name":"Get The Members In An Import","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/imports/200/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"member_id\": 200,\n \"change_type\": \"a\",\n \"member_status_id\": \"a\",\n \"email\": \"emma@myemma.com\"\n }\n]\n"}],"_postman_id":"334efd73-2913-aee2-1fd8-f1763251805b"},{"name":"Get Import By Id","id":"dd9fc261-cf90-44d4-5f1b-d4509d2a74c9","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/imports/#import_id","description":"Get information and statistics about this import.
\nReturns: Import details for the givenimport_id.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/imports","description":"Get information about all imports for this account.
\nReturns: An array of import details.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","members","imports"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"02a411dd-04bf-6fcd-a5a2-7de790da751b","name":"Get All Imports","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/members/imports"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n\n]"}],"_postman_id":"7a7518d9-ce00-821b-820a-e98b92acb7a7"},{"name":"Copy Members Into Group By Status","id":"728518bc-e528-81a0-7132-4ef24c64801d","request":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"member_status_id\": [\n \"a\",\n \"e\"\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/#group_id/copy","description":"Copy all account members of one or more statuses into a group.
\nParameters:
\na (active)o (optout)e (error)Returns: True
\nRaises: Http404 if the group does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"group_id\": 1\n}"},"url":"https://api.e2ma.net/{{account_id}}/members/status/:status_from/to/:status_to","description":"Update the status for a group of members, based on their current status.
\nValid status ids:
\na (active)
e (error)
f (forwarded)
o (optout)
Parameters:
\ngroup_id – Optional. Limit the update to members of the specified group
\nReturns: True
\nRaises: Http400 if the specified status is invalid
In addition to the various CRUD endpoints here related to members, you can also change the status of members, including opting them out.
\nYou’ll notice that there are calls related to individual members, but we also provide quite a few calls to deal with bulk updates of members. Please try to use these whenever possible as opposed to looping through a list of members and calling the individual member calls.
\nWhere this is especially important is when adding new members. To do a bulk import, you’ll POST to the /#account_id/members endpoint. In return, you’ll receive an import ID. You can use this ID to check the status and results of your import. Imports are generally pretty fast, but the time to completion can vary with greater system usage.
Create a Product for the given account
\nParameters:
\nReturns:
\nHttp200 - Product Created.Raises:
\nHttp400 if product data is in an invalid format.Http500 if an unexpected error occurs.Get Products in the given account
\nParameters:
\nReturns: Http200 - Found. An array of products.
Raises: Http500 if an unexpected error occurs.
Get a specific Product by ID
\nParameters:
\nReturns: Http200 - Product Found.
Raises:
\nHttp404 if product is not found.Http500 if an unexpected error occurs.Update a specific Product by ID
\nParameters:
\nReturns: Http200 - Product Updated.
Raises:
\nHttp400 if product data is an invalid format.Http404 if product is not found.Http500 if an unexpected error occurs.Delete a specific Product by ID
\nParameters:
\nReturns: Http200 - Product Deleted. True.
Raises:
\nHttp404 if product is not found.Http500 if an unexpected error occurs.Undelete a specific Product by ID
\nParameters:
\nReturns: Http200 - Product Undeleted. True.
Raises:
\nHttp404 if product is not found.Http500 if an unexpected error occurs.Create or Update Products in bulk asynchronously
\nParameters:
\nReturns:
\nHttp200 - Bulk Load Job Created.job_id - (string)Raises:
\nHttp400 if invalid request.Http500 if an unexpected error occurs.Get Bulk Load Job Status
\nParameters:
\nReturns:
\nHttp200 - Bulk job status returned.Raises:
\nHttp404 if no job is found.Http500 if an unexpected error occurs.Get Bulk Load Job Errors
\nParameters:
\nReturns:
\nHttp200 - Bulk job status returned.Raises:
\nHttp404 if no job is found.Http500 if an unexpected error occurs.Get an array of Products based on the provided criteria
\nMust be in the form of a query parameter.
\nParameters:
\nReturns:
\nHttp200 - Product(s) Found.Raises:
\nHttp400 if lookup paramaters are invalidHttp400 if no products were found.Http500 if an unexpected error occurs.Purge all products, permanently delete account’s products
\nThis is a private endpoint.
\nReturns:
\nHttp200 - Products Deleted.Raises:
\nHttp400 if account has orders. Orders must be purged before products.Http500 if an unexpected error occurs.Undelete multiple Products by ID
\nThis is a private endpoint.
\nparamters
\nReturns: Http200 - The number of Products that were undeleted.
Raises:
\nHttp400 if the product ids provided were in an invalid formatHttp500 if an unexpected error occurs.Get an array of Products based on the provided criteria
\nMust be in the form of a query parameter.
\nParameters:
\nReturns:
\nHttp200 - Product(s) Found.Raises:
\nHttp400 if lookup paramaters are invalidHttp400 if no products were found.Http500 if an unexpected error occurs.Create an Order for the given member
\nParameters:
\nReturns:
\nHttp200 - Order Created.Raises:
\nHttp400 if product data is in an invalid format.Http500 if an unexpected error occurs.Get Orders for a given member
\nParameters:
\nReturns:
\nHttp200 - Order Found.Raises:
\nHttp404 if no order is foundHttp500 if an unexpected error occurs.Create an Order from external source for existing or new member
\nThis call should be used when an Emma member id us not known. If the member already exists, it will attaqch an order to the member record. If it doesn not exist, it will be added. By deault, the member will be in LIMBO (a member without a group) unless an Emma group id is supplied in the request body/
\nParameters:
\nReturns:
\nHttp200 - Order Created.Raises:
\nHttp400 if order item product not foundHttp409 if source order already existsHttp500 if an unexpected error occurs.Get all of the orders in an account
\nReturns:
\nHttp200 - Orders Found.Raises:
\nHttp500 if an unexpected error occurs.Get a specific Member Order by ID
\nReturns:
\nHttp200 - Order Found.Raises:
\nHttp404 if no order is found or member does not existHttp500 if an unexpected error occurs.Update a specific Member Order by ID
\nParameters
\nReturns:
\nHttp200 - Order Updated.Raises:
\nHttp400 if order data is in an invalid formatHttp404 if no order is found or member does not existHttp500 if an unexpected error occurs.Delete All Orders and Order Items in the Account
\nReturns:
\nHttp200 - Orders and Order Items Deleted.Raises:
\nHttp500 if an unexpected error occurs.Create Orders in Bulk
\nRequest body should contain an array of orders
\nParameters:
\nReturns:
\nHttp200 - Bulk load orders job created.Raises:
\nHttp500 if an unexpected error occurs.Create Orders in Bulk, without knowing the emma member_id or emma product_id
\nRequest body should contain an array of orders
\nParameters:
\nReturns:
\nHttp200 - Bulk load orders job created.Raises:
\nHttp500 if an unexpected error occurs.Create Orders in Bulk, without knowing the emma member_id or emma product_id
\nParameters:
\nReturns:
\nHttp200 - Bulk load orders job created.Raises:
\nHttp400 if an invalid request form.Http500 if an unexpected error occurs.Get Bulk Load Job Status
\nParameters:
\nReturns:
\nHttp200 - Bulk job status returned.Raises:
\nHttp404 if no job is found.Http500 if an unexpected error occurs.Get Bulk Load Job Errors
\nParameters:
\nReturns:
\nHttp200 - Bulk job status returned.Raises:
\nHttp404 if no job is found.Http500 if an unexpected error occurs.Coming Soon!
\n","_postman_id":"cbc6bb4c-c462-38e1-dfce-95f08727c1fd"},{"name":"Response","item":[{"name":"Get Response","id":"a7040933-a8f8-afe0-237e-4632d2556a55","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response","description":"Get the response summary for an account.
\nThis method will return a month-based time series of data including sends, opens, clicks, mailings, forwards, and opt-outs. Test mailings and forwards are not included in the data returned.
\nParameters:
\n~). Example: 2011-04-01~2011-09-01. Optional argument to limit results to a date range. If one of the dates is omitted, the default will be either min date or now. If a single date is provided with no tilde, then only mailings sent on that date will be included.Returns: A list of objects with each object representing one month. Each object contains:
\nConverts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id","description":"Get the response summary for a particular mailing.
\nThis method will return the counts of each type of response activity for a particular mailing.
\nReturns: A single object with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/sends","description":"Get the list of messages that have been sent to an MTA for delivery.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/in_progress","description":"Get the list of messages that are in the queue, possibly sent, but not yet delivered.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/deliveries","description":"Get the list of messages that have finished delivery.
\nThis will include those that were successfully delivered, as well as those that failed due to hard or soft bounces.
\nThis list can be limited by delivery_type.
Parameters:
\nall if not provided: alldeliveredbouncedhardsoftReturns: An array of objects with the following fields:
\ndelivered, hard (bounce)soft (bounce)Raises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/opens","description":"Get the list of opened messages for this campaign.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/links","description":"Get the list of links for this mailing.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/clicks","description":"*Get the list of clicks for this mailing.
\nThis list can also be limited by member_id or link_id.
Parameters:
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/forwards","description":"Get the list of forwards for this mailing.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/optouts","description":"Get the list of optouts for this mailing.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/optouts","description":"Get the list of signups for this mailing.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/shares","description":"Get the list of shares for this mailing
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/customer_shares","description":"Get the list of customer shares for this mailing
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/customer_share_clicks","description":"Get the list of customer shares for this mailing
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#share_id/customer_share","description":"Get the customer share associated with the share id.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/response/#mailing_id/shares/overview","description":"Get overview of shares pertaining to this mailing_id.
\nReturns: An array of objects with the following fields:
\nRaises:
\nHttp404 if the mailing does not exist.Http404 if the mailing is not valid mailing type:m (standard mailings)t (test mailings)r (trigger mailings)We know that you want to do some fancy pivot tables with your response data, so we’ve provided quite a few endpoints here to give you access to that response data. You can get overview numbers for all of your mailings and also drill down into finding out the actual members who opened a particular mailing.
\n","_postman_id":"fbac2680-9011-efd6-19a2-1438754e3eaa"},{"name":"Searches","item":[{"name":"Get Searches","id":"a2aafa07-821a-130c-0cdf-c1b89307500d","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/searches","description":"Retrieve a list of saved searches.
\nParameters:
\nReturns: An array of searches.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","searches"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"9d3ad207-4d93-3a79-f9e8-5f0a8d205140","name":"Get Searches","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/searches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"search_id\": 200,\n \"optout_count\": 0,\n \"error_count\": 0,\n \"name\": \"Test Search\",\n \"criteria\": \"[\\\"or\\\", [\\\"group\\\", \\\"eq\\\", \\\"Monthly Newsletter\\\"],[\\\"group\\\", \\\"eq\\\", \\\"Widget Buyers\\\"]]\",\n \"deleted_at\": null,\n \"purged_at\": null,\n \"last_run_at\": null,\n \"active_count\": 0,\n \"account_id\": 100\n },\n {\n \"search_id\": 201,\n \"optout_count\": 0,\n \"error_count\": 0,\n \"name\": \"Second Test Search\",\n \"criteria\": \"[\\\"group\\\", \\\"eq\\\", \\\"Special Events\\\"]\",\n \"deleted_at\": null,\n \"purged_at\": null,\n \"last_run_at\": null,\n \"active_count\": 0,\n \"account_id\": 100\n }\n]"},{"id":"d220a17f-f968-3cc5-4d9b-7596b0c497ad","name":"Get Searches","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/searches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"search_id\": 200,\n \"optout_count\": 0,\n \"error_count\": 0,\n \"name\": \"Test Search\",\n \"criteria\": \"[\\\"or\\\", [\\\"group\\\", \\\"eq\\\", \\\"Monthly Newsletter\\\"],[\\\"group\\\", \\\"eq\\\", \\\"Widget Buyers\\\"]]\",\n \"deleted_at\": null,\n \"purged_at\": null,\n \"last_run_at\": null,\n \"active_count\": 0,\n \"account_id\": 100\n },\n {\n \"search_id\": 201,\n \"optout_count\": 0,\n \"error_count\": 0,\n \"name\": \"Second Test Search\",\n \"criteria\": \"[\\\"group\\\", \\\"eq\\\", \\\"Special Events\\\"]\",\n \"deleted_at\": null,\n \"purged_at\": null,\n \"last_run_at\": null,\n \"active_count\": 0,\n \"account_id\": 100\n }\n]"}],"_postman_id":"a2aafa07-821a-130c-0cdf-c1b89307500d"},{"name":"Get Search By Id","id":"438ab49c-f1f6-bf94-574b-f95a0721ce5a","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/searches/#search_id","description":"Get the details for a saved search.
\nReturns: A search.
\nParameters:
\nRaises: Http404 if the search does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Search\", \n \"criteria\": [\n \"or\", \n [\n \"group\", \n \"eq\", \n \"Monthly Newsletter\"\n ], \n [\n \"group\", \n \"eq\", \n \"Widget Buyers\"\n ]\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/searches","description":"Create a saved search.
\nThe detail of a search is specified in a JSON structure that describes the clauses to be applied using groups of filter type, operator and value. Where the filter type is member_field, the referenced field should be specified by joining with a colon. For example:
[\"and\",\n [\"or\",\n [\"group\", \"eq\", \"my list\"],\n [\"group\", \"contains\", \"old\"]\n ],\n [\"not\", [\"member_field\", \"soup\", \"eq\", \"lentil\"]],\n [\"opened\", 123249, \"between\", \"2011-01-22, 2011-01-31\"],\n [\"clicked\", 83927]\n]\nThe following parameters are required:
\nParameters:
\nReturns: The ID of the new search
\n**Raises: Http400 if the search is invalid.
Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"criteria\": [\n \"or\", \n [\n \"group\", \n \"eq\", \n \"Monthly Newsletter\"\n ], \n [\n \"group\", \n \"eq\", \n \"Special Events\"\n ]\n ]\n}"},"url":"https://api.e2ma.net/{{account_id}}/searches/#search_id","description":"Update a saved search.
\nNo parameters are required, but either the name or criteria parameter must be present for an update to occur.
\nParameters:
\nReturns: True if the update was successful
\nRaises:
\nHttp404 if the search does not exist.Http400 if the search criteria is invalid.Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/searches/#search_id","description":"Delete a saved search. The member records referred to by the search are not affected.
\n**Returns:**True if the search is deleted.
\nRaises: Http404 if the search does not exist.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/searches/#search_id/members","description":"Get the members matching the search.
\nReturns: An array of members.
\nRaises: Http404 if the search does not exist.
These endpoints allow you to create, edit, and delete searches. You can also retrieve the members matching any search created in your account. You can get more details on how to construct searches.
\n","_postman_id":"3e7c4bc0-a2eb-a195-f7b3-f64c50d7c70b"},{"name":"Signup Forms","item":[{"name":"Get Signup Forms","id":"283dff5b-8ec1-d274-797a-c60d28bab4fb","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/signup_forms","description":"Gets a list of this account’s signup forms.
\nReturns: An array of signup forms.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","signup_forms"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"8496916f-395f-2dca-768a-2a959ac72fd7","name":"Get Signup Forms","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/signup_forms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"id\": 200,\n \"name\": \"Your Default Signup Form\"\n },\n {\n \"id\": 201,\n \"name\": \"My First Signup Form\"\n }\n\n]"}],"_postman_id":"283dff5b-8ec1-d274-797a-c60d28bab4fb"}],"id":"e9ee0ff6-4ad6-173d-abbd-b1b6f5d35122","description":"With this endpoint, you can list all of your signup forms.
\n","_postman_id":"e9ee0ff6-4ad6-173d-abbd-b1b6f5d35122"},{"name":"Webhooks","item":[{"name":"Get Webhooks","id":"144e7895-8fde-eed3-80a5-ab4245dc4cae","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/webhooks","description":"Get a basic listing of all webhooks associated with an account.
\nReturns: A list of webhooks that belong to the given account.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","webhooks"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"fad77820-1197-2e8c-1e3b-4fccd366d391","name":"Get Webhooks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"[\n {\n \"url\": \"http://myemma.com\",\n \"webhook_id\": 100,\n \"method\": \"POST\",\n \"account_id\": 100,\n \"event\": \"mailing_finish\"\n },\n {\n \"url\": \"http://tech.myemma.com\",\n \"webhook_id\": 101,\n \"method\": \"POST\",\n \"account_id\": 100,\n \"event\": \"mailing_finish\"\n }\n]"}],"_postman_id":"144e7895-8fde-eed3-80a5-ab4245dc4cae"},{"name":"Get Webhook By Id","id":"bb4bd3b8-37ec-343b-8eee-9dae32170dc2","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/webhooks/#webhook_id","description":"Get information for a specific webhook belonging to a specific account.
\nReturns: Details for a single webhook
\nRaises: Http404 if no webhook found
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/webhooks/events","description":"Get a listing of all event types that are available for webhooks.
\nReturns: A list of event types and descriptions
\n","urlObject":{"protocol":"https","path":["{{account_id}}","webhooks","events"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"8f52cd99-305d-7541-a04e-0c987b001744","name":"Get Webhook Event Types","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.e2ma.net/{{account_id}}/webhooks/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"\n[\n {\n \"event_name\": \"mailing_finish\",\n \"webhook_event_id\": 1,\n \"description\": \"Fired when a mailing is finished.\"\n },\n {\n \"event_name\": \"mailing_start\",\n \"webhook_event_id\": 2,\n \"description\": \"Fired when a mailing starts.\"\n },\n {\n \"event_name\": \"member_signup\",\n \"webhook_event_id\": 3,\n \"description\": \"Fired when a member signs up through a signup form.\"\n },\n {\n \"event_name\": \"message_open\",\n \"webhook_event_id\": 4,\n \"description\": \"Fired when a message is opened.\"\n },\n {\n \"event_name\": \"message_click\",\n \"webhook_event_id\": 5,\n \"description\": \"Fired when a link in a message is clicked.\"\n },\n {\n \"event_name\": \"member_optout\",\n \"webhook_event_id\": 6,\n \"description\": \"Fired when a member opts out.\"\n },\n {\n \"event_name\": \"message_share\",\n \"webhook_event_id\": 7,\n \"description\": \"Fired when a member shares a message.\"\n },\n {\n \"event_name\": \"message_share_click\",\n \"webhook_event_id\": 8,\n \"description\": \"Fired when a someone follows a link a member has shared.\"\n },\n {\n \"event_name\": \"import_finish\",\n \"webhook_event_id\": 9,\n \"description\": \"Fired when a member import completes.\"\n },\n {\n \"event_name\": \"member_update\",\n \"webhook_event_id\": 10,\n \"description\": \"Fired when a member is updated.\"\n },\n {\n \"event_name\": \"member_delete\",\n \"webhook_event_id\": 11,\n \"description\": \"Fired when a member is deleted.\"\n },\n {\n \"event_name\": \"member_add_to_group\",\n \"webhook_event_id\": 12,\n \"description\": \"Fired when a member(s) is added to a group(s).\"\n },\n {\n \"event_name\": \"member_remove_from_group\",\n \"webhook_event_id\": 13,\n \"description\": \"Fired when a member(s) is removed from a group(s).\"\n },\n {\n \"event_name\": \"group_create\",\n \"webhook_event_id\": 14,\n \"description\": \"Fired when a group is created.\"\n },\n {\n \"event_name\": \"group_delete\",\n \"webhook_event_id\": 15,\n \"description\": \"Fired when a group is deleted.\"\n },\n {\n \"event_name\": \"group_update\",\n \"webhook_event_id\": 16,\n \"description\": \"Fired when a group is updated.\"\n },\n {\n \"event_name\": \"member_status_update\",\n \"webhook_event_id\": 17,\n \"description\": \"Fired when a member's status changes.\"\n },\n {\n \"event_name\": \"message_forward\",\n \"webhook_event_id\": 18,\n \"description\": \"Fired when a message is forwarded.\"\n },\n {\n \"event_name\": \"member_add\",\n \"webhook_event_id\": 19,\n \"description\": \"Fired when a single member is added.\"\n },\n {\n \"event_name\": \"field_create\",\n \"webhook_event_id\": 20,\n \"description\": \"Fired when a field is created.\"\n },\n {\n \"event_name\": \"field_delete\",\n \"webhook_event_id\": 21,\n \"description\": \"Fired when a field is deleted.\"\n },\n {\n \"event_name\": \"field_update\",\n \"webhook_event_id\": 22,\n \"description\": \"Fired when a field is updated.\"\n }\n]"}],"_postman_id":"0bcf6a37-f7ca-dca2-ab1e-e558b0b6e8ff"},{"name":"Create Webhooks","id":"c2401ad7-806b-fe09-a198-ad0fb3196869","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"http://myemma.com/blog/\", \n \"event\": \"mailing_finish\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/webhooks","description":"Create an new webhook.
\nIf method is POST, the data will be posted to the given URL as a blob of JSON. If the method is GET the data will be added to the query string of your URL as a url encoded blob of JSON in a key called payload.
user_id but this is deprecated.Returns: A reference to the newly created webhook.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","webhooks"],"host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"95106baf-70e8-4372-ac68-067d45a71994","name":"Create A Webhook","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"},{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"http://myemma.com/blog/\", \n \"event\": \"mailing_finish\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"1024"}],"_postman_id":"c2401ad7-806b-fe09-a198-ad0fb3196869"},{"name":"Update Webhook","id":"05fafb3b-60e3-b727-c158-969be76a5191","request":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"http://tech.myemma.com/\"\n}"},"url":"https://api.e2ma.net/{{account_id}}/webhooks/#webhook_id","description":"Update an existing webhook. Takes the same params as create_webhook.
\nReturns: The id of the updated webhook, or False if the update failed.
\nRaises: Http404 if the webhook cannot be found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/webhooks/#webhook_id","description":"Deletes an existing webhook.*
\nReturns: True if the webhook deleted successufully.
\nRaises: Http404 if no webhook found.
Converts to b64 for Authenticating the Emma Public API
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/webhooks/#webhook_id","description":"Delete all webhooks registered for an account.
\nReturns: True if the webhooks deleted successufully.
\n","urlObject":{"protocol":"https","path":["{{account_id}}","webhooks",""],"hash":"webhook_id","host":["api","e2ma","net"],"query":[],"variable":[]}},"response":[{"id":"87be2ff8-901f-2fd1-5dad-5800cb81fd9a","name":"Delete All Webhooks","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{public_api_key}}:{{private_api_key}}","description":"Converts to b64 for Authenticating the Emma Public API"}],"body":{"mode":"raw","raw":""},"url":"https://api.e2ma.net/{{account_id}}/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"true"}],"_postman_id":"41749073-f44c-6904-46a1-843b52554450"}],"id":"3df07018-b509-d27a-bcd1-724d18892f08","description":"You can manage your webhooks with these endpoints. Of particular interest might be the GET /#account_id/webhooks/events endpoint which lets you know which events our system can send out webhooks for. You can get more info about how our webhooks work.