Consists of four related APIs:
All APIs use Basic Auth. All APIs are RESTful.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2749738","collectionId":"3faad2c1-1bf3-4640-9413-72fe525382d7","publishedId":"RzfjnTbq","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-12-12T18:42:49.000Z"},"item":[{"name":"Members API","item":[{"name":"GET Members","id":"c3d9be02-12c3-4d66-a048-e2fa02e27ed3","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Get all. Used with the \"list\" parameter to return all members for the Engagement Console all group in left pane.
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","members","list","{{list_id}}"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[{"key":"status","value":"unsubscribed"},{"key":"limit","value":"25"},{"key":"offset","value":"2"}],"variable":[]}},"response":[],"_postman_id":"c3d9be02-12c3-4d66-a048-e2fa02e27ed3"},{"name":"GET Members v2","id":"56312141-2dc9-4c8b-aef0-fd4474f39e79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Returns carrier information as well
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","members","list","{{list_id}}"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[{"key":"status","value":"unsubscribed"},{"key":"limit","value":"25"},{"key":"offset","value":"2"}],"variable":[]}},"response":[],"_postman_id":"56312141-2dc9-4c8b-aef0-fd4474f39e79"},{"name":"GET Members Count","id":"f28f52e6-068f-46fb-a582-2cd531a63e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Get count of members in a given account.
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","members","count"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f28f52e6-068f-46fb-a582-2cd531a63e12"},{"name":"Member Query - single member","event":[{"listen":"test","script":{"id":"6430f5e7-fab2-4a0f-9639-a0c5f34df4a5","exec":["let amid = pm.response.json().content.audience_member_id;","","pm.environment.set(\"audience_member_id\", amid);"],"type":"text/javascript"}}],"id":"073f93a7-b3aa-4717-9d05-47ed2c640556","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Returns the member profile for a single member. Put in audience_member_id for member_id
Returns member carrier information as well.
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","v2.0","members","1481881"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2837a13-c1fb-4132-bd88-f68792328b21"},{"name":"Member Query - identifiers search","event":[{"listen":"test","script":{"id":"f5f0551c-8ce9-4e55-a481-444958c33504","exec":["let amid = pm.response.json().content[0].audience_member_id;","","pm.environment.set(\"audience_member_id\", amid);"],"type":"text/javascript"}}],"id":"b1f030bb-0842-446f-ba83-67ccbf545a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Returns one or more audience members matching the query paramters.
Will return all matching members. Parameters are exact search unless otherwise noted.
\nexample: https://{{env}}ms-api.mpulsemobile.com/REST/accounts/{{account_id}}/members/search?first_name=Leslie&last_name=Wife
Returns carrier information as well
\nReturns one or more audience members matching the query paramters.
Will return all matching members. Parameters are exact search unless otherwise noted.
\nexample: https://{{env}}ms-api.mpulsemobile.com/REST/accounts/{{account_id}}/members/search?first_name=Leslie&last_name=Wife
Return multiple audience members. Include optional query parameters.
Creates a single audience member. Must include at least one field's worth of information. You do not need to include any identifiers. If you include identifiers (email, phone_number, client_member_id, app_member_id), they must be unique and valid, i.e. you can't add a member with a landline as a phone number.
You can also include whatever custom fields are set up for the account.
Create multiple members.
\nMust include at least one field's worth of information. You do not need to include any identifiers. If you include identifiers (email, phone_number, client_member_id, app_member_id), they must be unique and valid, i.e. you can't add a member with a landline as a phone number.
You can also include whatever custom fields are set up for the account.
Update a given member by audience_member_id.
\nWill only replace/update included information in the request body. To null out a field, include it as blank.
Delete a given member, by audience_member_id.
Passthrough API for Elasticsearch on platform.
\nTakes account ID passed in URL and uses that as ES index.
\nWill pass whatever query is sent through for search and return in the format that Engagement Console expects, i.e. first name, last name, client member ID, email, mobile phone, and id (audience member ID).
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","membersearch"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"da63dedf-ed31-4929-be27-8125ce7e8573"},{"name":"Advanced Members Search API v2","id":"e61cc6b2-75c9-4c6f-b5be-aa66cad659c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Passthrough API for Elasticsearch on platform.
\nReturns carrier information as well.
\nTakes account ID passed in URL and uses that as ES index.
\nWill pass whatever query is sent through for search and return in the format that Engagement Console expects, i.e. first name, last name, client member ID, email, mobile phone, and id (audience member ID).
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","v2.0","membersearch"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"e61cc6b2-75c9-4c6f-b5be-aa66cad659c0"}],"id":"fca13590-0ba3-446c-94af-20c713448e07","description":"The Members API is an mPulse-internal only API for creating, retrieving, updating, and deleting members. This is a RESTful API where endpoints are intended for single, intuitive operations that return quickly.
\n\"rmenabled\": \"true\" -- will set the user to be able to receive RCS messages (assuming s/he also has an RCS phone). This field cannot be updated via the Audience API.
This field populates preferred_language on the member profile (the difference between preferred_language and language is due to legacy issues from the separate member model on Hermes).
The Members API maps the ISO code to the language (Hermes used to have its own mapping based on the ISO codes for English & Spanish). Use the two-letter value as the API value for langauge. Responses will return the two-letter ISO code as well.
Returns relationships for a given member; used for Shared Contact to show if a member is a dependent or dependee.
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","members","relationships","{{audience_member_id}}"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe48af69-37f1-4b7e-b4b6-0fdd38be09c4"},{"name":"Create Relationship","id":"39c2ba7c-06b7-4f90-9601-67d6ccd241f4","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Creates a dependent relationship for a given member with one or more existing members.
List the audience_member_id of the member to be a dependent and put the dependees in the dependees block. You can identify a dependee by one of the folllowing identifiers:
A dependent will inherit all of the identifiers from a dependee by default. You can then create a subscription for the dependent on that channel by using the Subscriptions API.
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","members","relationships"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"39c2ba7c-06b7-4f90-9601-67d6ccd241f4"},{"name":"Delete Specific Relationship","id":"74e3a3c3-17f4-4025-8105-ea5bdc0c47e5","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Removes a specific relationship between two members.
Pass in the dependee_member_id and the dependent_member_id of the relationship to be removed as query parameters.
When a relationship is removed, the dependent will be unsubscribed from all channels s/he is subscribed on with the dependeee's contact information (i.e. if Johnny Junior is subscribed on SMS to his mother's phone number and the relationship is removed, he will no longer be subscribed for SMS). If you wish to keep messaging the formerly dependent member, you will either need to make new relationships and subscriptions or add contact information and subscriptions.
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","members","relationships"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[{"key":"dependent_member_id","value":"1344495"},{"key":"dependee_member_id","value":"1341280"}],"variable":[]}},"response":[],"_postman_id":"74e3a3c3-17f4-4025-8105-ea5bdc0c47e5"}],"id":"91d53449-00f9-4230-85cb-57de90835d71","description":"The Relationships API is an mPulse-internal only API for retrieving and managing information around the Shared Contact feature. This is used for returning whether or not members are dependents or dependees, for creating a dependent member, and for changing member dependent/dependee status.
\n","event":[{"listen":"prerequest","script":{"id":"18615a1c-e5d8-4132-a292-ecac27b894cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ee407591-540f-4966-8803-3c00327d3252","type":"text/javascript","exec":[""]}}],"_postman_id":"91d53449-00f9-4230-85cb-57de90835d71"},{"name":"Subscriptions API","item":[{"name":"Query Subscriptions","id":"41983f8f-ed63-4b7a-9842-10dad9c9bf5a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Returns subscriptions by channel for a given member whose audience_member_id is passed in the request.
Creates one or more subscriptions for a single member on one or more lists. Must pass in at least one channel per list. Pass in audience_member_id in the request.
Truly RESTful -- will only create a subscription where one did not formerly exist. Use the Update Subscription API to unsubscribe a member or subscribe a member who is already unsubscribed.
Creates one or more subscriptions for a single member as a dependent on one or more lists. Must pass in at least one channel per list. Pass in audience_member_id in the request. Must have dependee_member_id block.
Updates one or more subscriptions for a given member. Used to subscribe a member who is unsubscribed and/or subscribe a member who is subscribed.
Actions are per channel and are independent, i.e. you can subscribe a member to email and unsubscribe from SMS in the same request for the same list. Can be used to unsubscribe dependents as well as \"normal\" members.
Will error out if you try to subscribe a member who is not subscribed; use the Create Subscription API instead.
Pass in status parameter in request body.
The Subscriptions API is an mPulse-internal only API for creating, retrieving, and updating Member Subscriptions.
\n","event":[{"listen":"prerequest","script":{"id":"26dd8fe7-81ed-446e-894d-0ce47a28a887","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"975970d3-d31b-459c-9111-274720e94c40","type":"text/javascript","exec":[""]}}],"_postman_id":"f7e3849f-9ef8-4f31-aa54-817e3c62bbc8"},{"name":"Member Activities API","item":[{"name":"Member Activities","id":"012f2601-d97d-450a-b543-5e7cddf57df7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}],"advancedConfig":[{"key":"showPassword","value":"Returns member activity for a given member whose audience_member_id is passed in the request.
Can pass optional query parameters:
If results=before, returns ordered by activity_date desc; if results=after, returns ordered by activity_date asc. Defaults to last 365 days worth of data unless you pass in archive=true.
Returns:
GET Member Activities leveraging Elasticsearch (vs. database)
\n","urlObject":{"protocol":"https","path":["REST","accounts","{{account_id}}","v3.0","member_activities","{{audience_member_id}}",""],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[{"key":"limit","value":"50"},{"key":"timestamp","value":"2021-03-30_00:00:00"},{"key":"after","value":"before"},{"key":"list_id","value":"2288"}],"variable":[]}},"response":[],"_postman_id":"40e227c0-6524-4b43-be92-539c50dd4df3"},{"name":"POST Member Activities API","id":"654da5c2-fe01-4b4a-8112-4fa4ecd07202","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"cache-control","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"sso-access-token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1OTU4OTIzNTAsInVzZXJfaWQiOjIwMSwidXNlcm5hbWUiOiJqb3NoX3N0YWdpbmciLCJvcmlnX2lhdCI6MTU5NTg4ODc1MCwiZW1haWwiOiJqb3NoLmxldml0YW5AbXB1bHNlbW9iaWxlLmNvbSJ9._9WkCeUV-0ooKeQqZkTkuYla3v8bsAdD0-lHMm8wew0"}],"body":{"mode":"raw","raw":"{\n \"audience_member_id\": 43497191,\n \"original_id\": 1234567,\n \"action\": \"link_clicked\",\n \"content\": \n {\n \"url\": \"https://www.joshlevitan.com\",\n \"useragent\": \"Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)\"\n },\n \"channel\": \"mobileweb\"\n}"},"url":"https://{{env}}ms-api.mpulsemobile.com/account/{{account_id}}/member_activities","description":"Create a member activity entry.
\n","urlObject":{"protocol":"https","path":["account","{{account_id}}","member_activities"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"654da5c2-fe01-4b4a-8112-4fa4ecd07202"},{"name":"POST Member Activities API - dob validation","id":"336ea580-243f-4632-ac0f-2fa9595c7751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"cache-control","value":"no-cache"},{"key":"content-type","value":"application/json"},{"key":"sso-access-token","value":"{{auth_token}}"}],"body":{"mode":"raw","raw":"{\n \"audience_member_id\": 43497191,\n \"original_id\": 12345678,\n \"action\": \"validation_attempt\",\n \"content\": \n {\n \"field_name\": \"date_of_birth\", \n \"input\": \"11-13-1973\",\n \"success\": true \n},\n\"activity_date\": \"2020-08-07 06:03:43.178779-07\",\n \"channel\": \"mobileweb\",\n \"reference_id\": \"josh12345\"\n}"},"url":"https://{{env}}ms-api.mpulsemobile.com/account/{{account_id}}/member_activities","urlObject":{"protocol":"https","path":["account","{{account_id}}","member_activities"],"host":["{{env}}ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"336ea580-243f-4632-ac0f-2fa9595c7751"}],"id":"45af7398-4e33-4df2-bdf1-8a30ae2f98ee","description":"The Member Activities API is an mPulse-internal only API.
\nThe GET API returns member activity, primarily for display in Engagement Console's center pane.
\nThe POST API is used to write to member_activity on ms5prod for external services like Morpheus (Mobile Web).
\nAuthorization is handled through the SSO token from the Auth Service.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f9f5df6e-ec4b-4cf2-92d9-52dc0fa166bc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5b513fea-b181-478c-956d-80dbdc889538","type":"text/javascript","exec":[""]}}],"_postman_id":"45af7398-4e33-4df2-bdf1-8a30ae2f98ee"}],"event":[{"listen":"prerequest","script":{"id":"89570e99-e012-4b5a-a368-1c9396d1cd45","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a47ab4e2-3f6f-4400-a153-fe0722fd37ad","type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response time is less than 200ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(200);","});"]}}]}