{"info":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","description":"

Authentication

API requests require Basic Authentication or Oauth authentication in addition to IP Whitelisting.

IP Whitelisting

Only whitelisted IP addresses are enabled for interfacing with mPulse APIs. To get access, please reach out to your Account Representative.

Basic Authentication

Basic Authentication uses a username and password to authenticate API requests. Basic Auth credentials can be generated using Program Manager.

How to Include in the Header

Username: user@example.com
\n
Password: mypassword
\n

Combine credentials
\n
1. user@example.com:mypassword
\n
Encode combined credentials in Base64
\n
1. Results in YOUR_ACCESS_TOKEN.
\n
Include in header
\n
1. Authorization: Basic YOUR_ACCESS_TOKEN
\n

OAuth 2.0 Authentication

OAuth 2.0 uses access tokens to authenticate API requests. To generate an Oauth token, review the Oauth section below.

How to Include in the Header

Include your access token in the Authorization header using the oauth scheme.

Header:

Authorization: oauth YOUR_ACCESS_TOKEN

Note: Replace YOUR_ACCESS_TOKEN with the actual access token obtained using the Oauth endpoint. Keep your access token secure and do not expose it publicly.

Summary of Headers

Authorization: Basic base64(username:password)
\n
Authorization: oauth YOUR_ACCESS_TOKEN
\n

Contact-Based Identifiers vs. Unique Member ID

Contact-Based Identifier Accounts

Use mobile_phone, email, or app_member_id as unique identifiers.
\n
When creating or updating members, you can identify them using these fields or id.
\n

Unique Member ID Accounts

Use client_member_id as the unique identifier.
\n
When creating or updating members, you can identify them using client_member_id or id.
\n

Note: In both account types, id (also referred to as Audience Member ID) can always be used to identify a member.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19138020","collectionId":"1da6a725-34a8-4729-b8e4-85ef5a787934","publishedId":"2sAXqnePeg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"20252c","highlight":"009ED9"},"publishDate":"2024-12-12T05:44:44.000Z"},"item":[{"name":"Member API","item":[{"name":"Create or Update Member(s)","id":"eff56fd8-94e6-4368-a052-435e224e4d1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"mobile_phone\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"gender\": \"\",\n \"birth_date\": \"\",\n \"land_line\": \"\",\n \"zip_code\": \"\",\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"business_phone\": \"\",\n \"fax\": \"\",\n \"company\": \"\",\n \"job\": \"\",\n \"app_member_id\": \"\",\n \"preferred_language\": \"\",\n \"preferred_timezone\": \"\",\n \"client_member_id\": \"\",\n \"custom_fields\": {},\n \"useragent\": \"\",\n \"rm_enabled\": false,\n \"subscriptions\": [\n {\n \"list_id\": \"\",\n \"channels\": [\n \"sms\", \"ivr\", \"email\"\n ],\n \"disable_welcome_message\": false,\n \"force_subscribe\": false,\n \"action\" : \"subscribe\"\n },\n {\n \"list_id\": \"\",\n \"channels\": [\n \"ivr\"\n ],\n \"disable_welcome_message\": false,\n \"force_subscribe\": false,\n \"action\" : \"unsubscribe\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://members.mpulsemobile.com/api/v1/accounts/{{account_id}}/members","description":"

Description

POST /api/v1/accounts/{account_id}/members

Create or update member(s) in the specified account - including subscribing, unsubscribing, updating data, and any other data related to member information.

Path Parameters

account_id (string) Required: The ID of your account.

Request Body

members (array of objects) Required: An array of member objects to create or update.

Member Object Fields

Identification Fields (depending on account type):
\n
- Contact-Based Identifier Accounts: Use one or more of the following:
  \n
  - email (string)
    \n
  - mobile_phone (string)
    \n
  - app_member_id (string)
    \n
  - id (integer)
    \n
  \n
- Unique Member ID Accounts: Use one of the following:
  \n
  - client_member_id (string)
    \n
  - id (integer)
    \n
  \n
\n
Standard Fields:
\n
- first_name (string)
  \n
- last_name (string)
  \n
- gender (string): Allowable values include \"female\", \"male\", \"transgender\", \"gender neutral\", \"non-binary\", \"agender\", \"pangender\", \"genderqueer\", \"two-spirit\", \"third gender\", \"transgender male\", \"transgender female\", \"other\".
  \n
- birth_date (string): Date in \"YYYY-MM-DD\" format.
  \n
- preferred_language (string): Language name in lowercase (e.g., \"english\", \"spanish\").
  \n
- preferred_timezone (string): Timezone identifier (e.g., \"America/Los_Angeles\").
  \n
- custom_fields (object): Key-value pairs for custom data. Custom fields must exist in the system.
  \n
\n
Subscription Fields:
\n
- subscriptions (array of objects): Details of the member's subscriptions.
  \n
  - channels (array of strings) Required: Channels to subscribe to. Allowable values:
    \n
    - \"sms\"
      \n
    - \"email\"
      \n
    - \"ivr\"
      \n
    \n
  - disable_welcome_message (boolean): If true, disables the welcome message.
    \n
  - force_subscribe (boolean): If true, forces the subscription even if previously unsubscribed.
    \n
  - action(string) : If subscribe member will be subscribed, if unsubscribe member will be unsubscribed.
    \n
  \n
\n

Example Request Body:

{\n    \"members\": [\n        {\n            \"client_member_id\": \"client123\",\n            \"email\": \"john.doe@example.com\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"gender\": \"Male\",\n            \"birth_date\": \"1990-01-01\",\n            \"preferred_language\": \"english\",\n            \"preferred_timezone\": \"America/Los_Angeles\",\n            \"rm_enabled\": false,\n            \"custom_fields\": {\n                \"membership_level\": \"Gold\",\n                \"referral_code\": \"ABC123\"\n            },\n            \"subscriptions\": [\n                {\n                    \"list_id\": 1001,\n                    \"channels\": [\"email\", \"sms\"],\n                    \"disable_welcome_message\": false,\n                    \"force_subscribe\": false,\n                    \"action\" : \"subscribe\"\n                }\n            ]\n        }\n    ]\n}\n\n

Response

A JSON object containing an array of the created or updated member objects.A JSON object containing an array of the created or updated member objects. Each member object may include an errors array if there were any validation errors, and a success boolean indicating if the operation was successful for that member.

Success Response Example

{\n    \"members\": [\n        {\n            \"id\": 133994543,\n            \"created_on\": \"2024-09-12T15:13:52.813387-07:00\",\n            \"last_modified_on\": \"2024-09-12T15:13:52.813387-07:00\",\n            \"email\": \"john.doe@example.com\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"gender\": \"male\",\n            \"birth_date\": \"1990-01-01\",\n            \"preferred_language\": \"english\",\n            \"preferred_timezone\": \"America/Los_Angeles\",\n            \"client_member_id\": \"client123\",\n            \"custom_fields\": {},\n            \"rm_enabled\": false,\n            \"subscriptions\": [\n                {\n                    \"list_id\": 22249,\n                    \"channels\": [\n                        {\n                            \"name\": \"email\",\n                            \"status\": \"ACTIVE\",\n                            \"status_reason\": \"subscribed\"\n                        },\n                        {\n                            \"name\": \"sms\",\n                            \"status\": null,\n                            \"status_reason\": \"not_list_enabled\"\n                        }\n                    ],\n                    \"disable_welcome_message\": false,\n                    \"force_subscribe\": false,\n                    \"action\": \"subscribe\"\n                },\n                {\n                    \"list_id\": 21692,\n                    \"channels\": [\n                        {\n                            \"name\": \"ivr\",\n                            \"status\": null,\n                            \"status_reason\": \"no_subscription_identifier\"\n                        }\n                    ],\n                    \"disable_welcome_message\": false,\n                    \"force_subscribe\": false,\n                    \"action\": \"subscribe\"\n                }\n            ],\n            \"errors\": null,\n            \"success\": true\n        }\n    ]\n}\n\n

Error Response Example

{\n    \"members\": [\n        {\n            \"id\": null,\n            \"created_on\": null,\n            \"last_modified_on\": null,\n            \"email\": \"john.doe@example.com\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"gender\": \"Anc\",\n            \"birth_date\": \"1990-01-0\",\n            \"preferred_language\": \"en\",\n            \"preferred_timezone\": \"America/os_Angeles\",\n            \"client_member_id\": \"client123\",\n            \"custom_fields\": {},\n            \"rm_enabled\": false,\n            \"subscriptions\": [],\n            \"errors\": [\n                {\n                    \"field\": \"gender\",\n                    \"message\": \"gender:Invalid value Anc. Valid options are female,male,transgender,gender neutral,non-binary,agender,pangender,genderqueer,two-spirit,third gender,transgender male,transgender female,other\",\n                    \"error_code\": \"field_validation_failed\",\n                    \"is_failed\": true\n                },\n                {\n                    \"field\": \"birth_date\",\n                    \"message\": \"birth_date:Invalid date format with value 1990-01-0\",\n                    \"error_code\": \"field_validation_failed\",\n                    \"is_failed\": true\n                },\n                {\n                    \"field\": \"preferred_language\",\n                    \"message\": \"preferred_language:Invalid value en. Valid options are english,spanish,(afan) oromo,...\",\n                    \"error_code\": \"field_validation_failed\",\n                    \"is_failed\": true\n                },\n                {\n                    \"field\": \"custom_fields.membership_level\",\n                    \"message\": \"The field membership_level does not exist.\",\n                    \"error_code\": \"field_not_found\",\n                    \"is_failed\": true\n                },\n                {\n                    \"field\": \"preferred_timezone\",\n                    \"message\": \"preferred_timezone:Invalid value America/os_Angeles. Valid options are America/New_York, America/Chicago,...\",\n                    \"error_code\": \"field_validation_failed\",\n                    \"is_failed\": true\n                }\n            ],\n            \"success\": false\n        }\n    ]\n}\n\n

Error Handling

When validation errors occur, the API returns an errors array within each affected member object. Each error object contains:

field (string): The field that caused the error.
\n
message (string): A detailed error message.
\n
error_code (string): A code representing the error type.
\n
is_failed (boolean): Indicates if the operation failed due to this error.
\n

The success field for the member will be false if any errors are present.

Possible Error Codes

list_not_exist
\n
- The provided list ID does not exist or is not associated with the current account.
\n
field_not_found
\n
- The specified field does not exist in the system.
\n
field_validation_failed
\n
- The field failed validation due to an invalid value or format.
  \n
  - A required field may be missing.
    \n
  - An ID provided for a member may not be a number.
    \n
  \n
\n
id_not_exist
\n
- The provided Member ID does not exist or is not associated with the current account.
\n
missing_identifier
\n
- The Member record lacks an identifier (e.g., legacy identifiers or UMI) recognized by the current account.
\n
unknown_validation_failure
\n
- A catch-all for unspecified validation failures not covered by other specific error codes.
\n
merge_error
\n
- Multiple identifiers provided cannot be consolidated into a single existing member record.
\n

Subscription Errors

In the subscriptions array, each subscription may contain channels with potential errors, indicated by the status and status_reason fields.

Possible status Values:

\"ACTIVE\": Subscription is active.
\n
\"INACTIVE\": Subscription is inactive.
\n
null: Subscription does not exist for the member.
\n

Possible status_reason Values:

\"subscribed\": Successfully subscribed.
\n
\"already_unsubscribed\": Member has already unsubscribed from this channel.
\n
\"not_list_enabled\": The list does not support this channel.
\n
\"no_subscription_identifier\": Missing required subscription identifier for this channel.
\n

Subscription Error Example

{\n    \"list_id\": 22249,\n    \"channels\": [\n        {\n            \"name\": \"email\",\n            \"status\": \"INACTIVE\",\n            \"status_reason\": \"already_unsubscribed\"\n        },\n        {\n            \"name\": \"sms\",\n            \"status\": null,\n            \"status_reason\": \"not_list_enabled\"\n        }\n    ],\n    \"disable_welcome_message\": false,\n    \"force_subscribe\": false,\n    \"action\": \"subscribe\"\n}\n\n

\n","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","accounts","{{account_id}}","members"],"host":["members","mpulsemobile","com"],"query":[],"variable":[]}},"response":[{"id":"5a78de7b-3b72-409e-9437-8f6f813a8b78","name":"Create or Update Member(s)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"client_member_id\": \"client123\",\n \"email\": \"john.doe@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"gender\": \"male\",\n \"birth_date\": \"1990-01-01\",\n \"preferred_language\": \"english\",\n \"preferred_timezone\": \"America/Los_Angeles\",\n \"rm_enabled\": false,\n \"custom_fields\": {\n \"membership_level\": \"Gold\"\n },\n \"subscriptions\": [\n {\n \"list_id\": 1001,\n \"channels\": [\"email\"],\n \"disable_welcome_message\": false,\n \"force_subscribe\": false\n }\n ]\n },\n {\n \"client_member_id\": \"client124\",\n \"email\": \"jane.doe@example.com\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"gender\": \"unknown\",\n \"birth_date\": \"1985-13-01\", // Invalid date\n \"preferred_language\": \"en\", // Invalid language value\n \"preferred_timezone\": \"America/Nowhere\", // Invalid timezone\n \"rm_enabled\": false,\n \"custom_fields\": {\n \"membership_level\": \"Silver\",\n \"nonexistent_field\": \"Value\" // Field does not exist\n },\n \"subscriptions\": [\n {\n \"list_id\": 1002,\n \"channels\": [\"sms\"],\n \"disable_welcome_message\": false,\n \"force_subscribe\": false\n }\n ]\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://members.mpulsemobile.com/api/v1/accounts/{{account_id}}/members"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"members\": [\n {\n \"id\": 133994543,\n \"created_on\": \"2024-09-12T15:13:52.813387-07:00\",\n \"last_modified_on\": \"2024-09-12T15:13:52.813387-07:00\",\n \"email\": \"john.doe@example.com\",\n \"mobile_phone\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"gender\": \"male\",\n \"birth_date\": \"1990-01-01\",\n \"land_line\": null,\n \"zip_code\": null,\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"business_phone\": null,\n \"fax\": null,\n \"company\": null,\n \"job\": null,\n \"app_member_id\": null,\n \"app_name\": null,\n \"mobile_os\": null,\n \"map_id\": null,\n \"preferred_language\": \"english\",\n \"client_member_id\": \"client123\",\n \"custom_fields\": {\n \"membership_level\": \"Gold\"\n },\n \"useragent\": null,\n \"rm_enabled\": false,\n \"preferred_timezone\": \"America/Los_Angeles\",\n \"subscriptions\": [\n {\n \"list_id\": 1001,\n \"channels\": [\n {\n \"name\": \"email\",\n \"status\": \"ACTIVE\",\n \"status_reason\": \"subscribed\"\n }\n ],\n \"disable_welcome_message\": false,\n \"force_subscribe\": false,\n \"action\": \"subscribe\"\n }\n ],\n \"errors\": null,\n \"success\": true\n },\n {\n \"id\": null,\n \"created_on\": null,\n \"last_modified_on\": null,\n \"email\": \"jane.doe@example.com\",\n \"mobile_phone\": null,\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"gender\": \"unknown\",\n \"birth_date\": \"1985-13-01\",\n \"land_line\": null,\n \"zip_code\": null,\n \"address1\": null,\n \"address2\": null,\n \"city\": null,\n \"state\": null,\n \"country\": null,\n \"business_phone\": null,\n \"fax\": null,\n \"company\": null,\n \"job\": null,\n \"app_member_id\": null,\n \"app_name\": null,\n \"mobile_os\": null,\n \"map_id\": null,\n \"preferred_language\": \"en\",\n \"client_member_id\": \"client124\",\n \"custom_fields\": {\n \"membership_level\": \"Silver\",\n \"nonexistent_field\": \"Value\"\n },\n \"useragent\": null,\n \"rm_enabled\": false,\n \"preferred_timezone\": \"America/Nowhere\",\n \"subscriptions\": [\n {\n \"list_id\": 1002,\n \"channels\": [\n {\n \"name\": \"sms\",\n \"status\": null,\n \"status_reason\": \"no_subscription_identifier\"\n }\n ],\n \"disable_welcome_message\": false,\n \"force_subscribe\": false,\n \"action\": \"subscribe\"\n }\n ],\n \"errors\": [\n {\n \"field\": \"gender\",\n \"message\": \"gender:Invalid value unknown. Valid options are female,male,transgender,gender neutral,non-binary,agender,pangender,genderqueer,two-spirit,third gender,transgender male,transgender female,other\",\n \"error_code\": \"field_validation_failed\",\n \"is_failed\": true\n },\n {\n \"field\": \"birth_date\",\n \"message\": \"birth_date:Invalid date format with value 1985-13-01\",\n \"error_code\": \"field_validation_failed\",\n \"is_failed\": true\n },\n {\n \"field\": \"preferred_language\",\n \"message\": \"preferred_language:Invalid value en. Valid options are english,spanish,(afan) oromo,abkhazian,afar,...\",\n \"error_code\": \"field_validation_failed\",\n \"is_failed\": true\n },\n {\n \"field\": \"preferred_timezone\",\n \"message\": \"preferred_timezone:Invalid value America/Nowhere. Valid options are America/New_York,America/Chicago,...\",\n \"error_code\": \"field_validation_failed\",\n \"is_failed\": true\n },\n {\n \"field\": \"custom_fields.nonexistent_field\",\n \"message\": \"The field nonexistent_field does not exist.\",\n \"error_code\": \"field_not_found\",\n \"is_failed\": true\n }\n ],\n \"success\": false\n }\n ]\n}\n"}],"_postman_id":"eff56fd8-94e6-4368-a052-435e224e4d1e"},{"name":"Get Member","id":"f1c240b0-87c0-4a75-8fd5-46c353c185a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://members.mpulsemobile.com/api/v1/accounts/{{account_id}}/members?member_ids=&member_ids=","description":"

GET /api/v1/accounts/{account_id}/members

Description

Retrieve information for one or more members in the specified account.

Path Parameters

account_id (string) Required: The ID of your account.

Query Parameters

identifier (string) Optional: The type of identifier used in member_ids. Allowable values:
\n
- \"id\" (default)
  \n
- \"client_member_id\"
  \n
\n
member_ids (string) Required: Provide up to 5 member identifiers as separate query parameters.
\n

Retrieving Multiple Members

To retrieve multiple members, you must pass multiple member_ids query parameters in the URL, with a maximum of up to 5.

Identifying Members

Contact-Based Identifier Accounts:
\n
- Use identifier=id (default) and provide system-assigned member IDs.
\n
Unique Member ID Accounts:
\n
- Use identifier=client_member_id and provide your own unique member IDs.
\n

Response

A JSON object containing an array of member data and a total count.

{\n    \"data\": [\n        {\n            \"id\": 131171889,\n            \"account_id\": 1992,\n            \"account_name\": \"Example Account\",\n            \"email\": \"john.doe@example.com\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"gender\": null,\n            \"birth_date\": \"1992-04-17\",\n            \"client_member_id\": \"client123\",\n            \"custom_fields\": {},\n            \"rm_enabled\": false,\n            \"created_on\": \"2024-07-22T14:08:57.653071-07:00\",\n            \"last_modified_on\": \"2024-09-12T15:13:52.813387-07:00\",\n            \"subscriptions\": [\n                {\n                    \"id\": 279541023,\n                    \"list_id\": 20083,\n                    \"sms_status\": \"INACTIVE\",\n                    \"email_status\": \"ACTIVE\",\n                    \"created_on\": \"2024-07-22T14:08:57.754545-07:00\",\n                    \"last_modified_on\": \"2024-07-23T07:30:18.902043-07:00\",\n                    \"list\": {\n                        \"id\": 20083,\n                        \"name\": \"Example List\",\n                        \"from_name\": \"Example Sender\",\n                        \"send_from\": \"no-reply@example.com\",\n                        \"reply_to\": \"support@example.com\",\n                        \"permission_reminder\": \"You are receiving this because you signed up...\",\n                        \"contact_address\": \"123 Example St, Anytown, USA\",\n                        \"keyword\": \"EXAMPLEKEYWORD\",\n                        \"description\": \"An example subscription list.\",\n                        \"shortcode\": \"12345\",\n                        \"shortcode_tokens\": {\n                            \"ACCOUNT_NAME\": \"Example Account\",\n                            \"MSGS\": \"5\",\n                            \"HELP_PHONE\": \"800-123-4567\",\n                            \"HELP_EMAIL\": \"support@example.com\",\n                            \"TIME_UNIT\": \"msg/mo\"\n                        },\n                        \"vcfcard\": \"\"\n                    }\n                }\n            ]\n        }\n    ],\n    \"total\": 1\n}\n\n

Introduction

The mPulse Member API allows you to manage members within your account. You can create, update, and retrieve member information, including their subscriptions to various channels such as SMS, Email, and IVR.

Key Differences with the Audience API

Support both identifier types

Member API supports accounts that leverage contact identifiers and unique member identifiers.

Field Name Differences

It should be noted that certain data elements are referenced and accessed differently than our legacy Audience API. The list below will continue to

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Audience API	Member API (New)
memberid	id
firstname	first_name
lastname	last_name
language	preferred_language
mobilephone	mobile_phone
clientmemberid	client_member_id
home_phone_number	land_line
zipcode	zip_code
appmemberid	app_member_id

Note: This list may not be exhaustive. When in doubt, reference this documentation for existing field standards. The standards on the Member API better match what is shown on Program Manager.

Accessing Custom Fields

In Audience API, custom fields are accessed through the custom_data object. In the new Member API, we retain the same name as one would expect and those fields are accessed through the custom_fields object.

\n","event":[{"listen":"prerequest","script":{"id":"0c27faeb-83c1-4438-b596-053c7f760269","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"8df67df3-3ce4-4e56-b912-29c6c133a90b","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"66e83281-e66b-4bc0-b25f-af3dcce832ce","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"Event API","item":[{"name":"Event Upload - One or Many Events","id":"40a2291b-0dee-4956-8424-db6153043557","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-API-Version","value":"2.0"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"body\": {\n \"events\": {\n \"name\": \"sample_event\",\n \"event\": [\n {\n \"scheduled_on\": \"+00:00\",\n \"timezone\": \"US/Pacific\",\n \"evaluation_scope\": \"no_rule\",\n \"client_member_id\": \"13105551212\",\n \"sample_attribute\": \"diabetes\",\n \"correlationid\": \"U123BZ7\"\n },\n {\n \"scheduled_on\": \"+00:00\",\n \"timezone\": \"US/Pacific\",\n \"evaluation_scope\": \"no_rule\",\n \"client_member_id\": \"412418261\",\n \"sample_attribute\": \"high blood pressure\",\n \"correlationid\": \"U123BZ9\"\n }\n ]\n },\n \"listid\": {{list_id}}\n }\n}"},"url":"https://ms-api.mpulsemobile.com/account/{{account_id}}/uploadEvent","description":"

POST /account/{account_id}/uploadEvent

Base URL: https://ms-api.mpulsemobile.com

Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Required	Values	Description
`X-Ms-Source`	yes	`api`	N/A
`X-Ms-Format`	yes	`json` or `xml`	N/A
`Authentication`	no	Basic Auth (see Account team for your credentials )	You must use either the `Authentication` header or the `Access-Token` header (see below)
`Access-Token`	no	`{ACCESS_TOKEN}`	If using OAuth for authentication, the value is `{ACCESS_TOKEN}`; see the OAuth Documentation for instructions on how to get a password using the OAuth Password Grant API
`X-Ms-API-Version`	yes	`2.0`	N/A
`X-Ms-Verbosity`	no	`simple` (default) or `full`	`simple` response does not include original request; `full` includes original request
`X-Ms-Async`	no	`false` (default) or `true`	Sync processing allows for 20 stanzas per request; async processing allows up to 2,000 stanzas per request

Request Body

The request body should be a JSON object containing the event details and the target list ID.

Root Object

body (object) Required: The main container for the request.

`body` Object Fields

events (object) Required: Contains the event name and event instances.
\n
- name (string) Required: The name of the event definition configured in your account.
  \n
- event (array of objects) Required: An array of event instances to process.
  \n
  - Each event instance can include:
    \n
    - scheduled_on (string) Optional: The scheduled time for the event in +HH:MM format (e.g., \"+00:00\" for immediate execution).
      \n
    - timezone (string) Optional: The timezone for scheduling (e.g., \"US/Pacific\").
      \n
    - evaluation_scope (string) Optional: The evaluation scope for rules. Default is \"no_rule\".
      \n
    - Member Identifiers: Required. Acceptable identifiers depend on your account type (see Member Identification for details).
      \n
    - Custom Attributes: Any additional attributes relevant to the event (e.g., \"sample_attribute\").
      \n
    - Correlation ID (string) Optional: A special correlationid attribute can be passed per event instance, which is associated to every downstream action like MESSAGE_SENT, LINK_CLICKED, MESSAGE_RECEIVED etc. triggered due to this event execution.
      \n
    \n
  \n
\n
listid (integer) Required: The ID of the list associated with the event.
\n

Example Request Body

{\n  \"body\": {\n    \"events\": {\n      \"name\": \"sample_event\",\n      \"event\": [\n        {\n          \"scheduled_on\": \"+00:00\",\n          \"timezone\": \"US/Pacific\",\n          \"evaluation_scope\": \"no_rule\",\n          \"client_member_id\": \"client123\",\n          \"sample_attribute\": \"diabetes\",\n          \"correlationid\": \"U123BZ7\"\n        },\n        {\n          \"scheduled_on\": \"+00:00\",\n          \"timezone\": \"US/Pacific\",\n          \"evaluation_scope\": \"no_rule\",\n          \"client_member_id\": \"client124\",\n          \"sample_attribute\": \"high blood pressure\",\n          \"correlationid\": \"U123BZ9\"\n        }\n      ]\n    },\n    \"listid\": 12345\n  }\n}\n\n

Error Response Example

{\n  \"body\": {\n    \"results\": {\n      \"processed_event_instances\": \"0\",\n      \"scheduled_messages\": \"0\",\n      \"errors\": \"1\",\n      \"details\": {\n        \"events_error\": {\n          \"error_code\": \"ERR-EVNTS-001\",\n          \"error_message\": \"The 'event_name' provided in the request does not exist in the account.\"\n        }\n      }\n    }\n  }\n}\n\n

Error Response Structure

When an error occurs, the response will include:

errors: The number of errors encountered.
\n
details:
\n
- events_error (object): Contains error details.
  \n
  - error_code: The specific error code.
    \n
  - error_message: A descriptive message about the error.
    \n
  \n
\n

Common Error Codes

Below is a list of error codes that the Event Upload API may return, along with their descriptions:

General Errors

ERR-EVNTS-000: The XML in the request could not be processed.
\n
ERR-EVNTS-001: The event_name provided in the request does not exist in the account.
\n
ERR-EVNTS-002: The listid tag is either missing or does not contain a value.
\n
ERR-EVNTS-003: The listid does not exist in the account.
\n
ERR-EVNTS-004: The listid exists in the account but is not active (i.e., it has been retired).
\n
ERR-EVNTS-011: The JSON in the request could not be processed.
\n
ERR-EVNTS-014: You passed a reserved character.
\n

Event Instance Errors

ERR-EVENT-000: The scheduled_on value provided is in the wrong format.
\n
ERR-EVENT-001: The scheduled_on value provided is in the past.
\n
ERR-EVENT-002: The timezone value provided is in the wrong format.
\n
ERR-EVENT-003: The evaluation_scope value provided is not one of the accepted values.
\n
ERR-EVENT-004: One or more required event attributes are missing.
\n
ERR-EVENT-005: The value for the given event attribute is invalid.
\n
ERR-EVENT-006: There are no active messages for the given event.
\n
ERR-EVENT-007: There are no active messages for the given event with the given evaluation scope.
\n
ERR-EVENT-008: The member in the event instance is either null or is not a valid member.
\n
ERR-EVENT-010: Message ID [message_id] not scheduled: The member is not subscribed to the [channel] channel on this list.
\n
ERR-EVENT-012: Message ID [message_id] not scheduled: Frequency limit for this member in this event instance has been reached.
\n
ERR-EVENT-013: Dialogue ID [dialogue_id] not scheduled: The member is not subscribed to the SMS channel on this list or the member does not lie in the segment.
\n

\n","urlObject":{"protocol":"https","path":["account","{{account_id}}","uploadEvent"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[{"id":"7fca1a8b-a878-45d1-b7d0-77acf8d5aab3","name":"Event Upload - One or Many Events","originalRequest":{"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-API-Version","value":"2.0"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"events\": [\n {\n \"client_member_id\": \"client123\",\n \"event_name\": \"appointment\",\n \"event_date\": \"2024-09-12T15:13:52Z\",\n \"properties\": {\n \"appointment_id\": \"41342321\",\n \"type\": \"checkup\"\n }\n },\n {\n \"client_member_id\": \"client124\",\n \"event_name\": \"\",\n \"event_date\": \"invalid-date\",\n \"properties\": {\n \"appointment_id\": \"41342321\",\n }\n }\n ]\n}\n"},"url":"https://ms-api.mpulsemobile.com/account/{{account_id}}/uploadEvent"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"events\": [\n {\n \"event_id\": \"evt_123456789\",\n \"client_member_id\": \"client123\",\n \"event_name\": \"appointment\",\n \"event_date\": \"2024-09-12T15:13:52Z\",\n \"properties\": {\n \"appointment_id\": \"41342321\",\n \"type\": \"checkup\"\n },\n \"errors\": null,\n \"success\": true\n },\n {\n \"event_id\": null,\n \"client_member_id\": \"client124\",\n \"event_name\": \"\",\n \"event_date\": \"invalid-date\",\n \"properties\": {\n \"item_id\": \"SKU67890\",\n \"amount\": \"not-a-number\"\n },\n \"errors\": [\n {\n \"field\": \"event_name\",\n \"message\": \"event_name is required.\",\n \"error_code\": \"field_validation_failed\",\n \"is_failed\": true\n },\n {\n \"field\": \"event_date\",\n \"message\": \"event_date: Invalid date format.\",\n \"error_code\": \"field_validation_failed\",\n \"is_failed\": true\n }\n ],\n \"success\": false\n }\n ]\n}\n"}],"_postman_id":"40a2291b-0dee-4956-8424-db6153043557"},{"name":"Event Upload Async","id":"46780621-a612-4f81-9942-9f2d7d7362d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-API-Version","value":"2.0"},{"key":"X-Ms-Async","value":"true","type":"text"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"body\": {\n \"events\": {\n \"name\": \"sample event\",\n \"event\": {\n \"scheduled_on\": \"+00:00\",\n \"timezone\": \"US/Pacific\",\n \"evaluation_scope\": \"all\",\n \"memberid\": \"86793779\",\n \"correlationid\": \"ABC567\"\n \n } \n },\n \"listid\": 50806\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ms-api.mpulsemobile.com/account/{{account_id}}/uploadEvent","description":"

Event Upload Async

Base URL: https://ms-api.mpulsemobile.com/account/{{account_id}}/uploadEvent

Event Upload API when called with the header X-Ms-Async set to true will process events asynchronously. Rest of the request headers and payload remain the same as the regular non async version. If there are no errors, it will return a 200 OK response with a status URL having a unique request id.

Sample Response:

{\n  \"body\": {\n    \"result\": {\n      \"status\": \"success\",\n      \"message\": \"Upload Event is being processed in background. Status of processing is available on given URL.\",\n      \"url\": \"https://ms-api.mpulse.io/account/1458/uploadEventStatus?requestId=1458851e963a977a455496bb412ea49d004e\"\n    }\n  }\n}\n\n

To know the final result of the upload, make a GET request to the status URL:

https://ms-api.mpulse.io/account/1458/uploadEventStatus?requestId=1458851e963a977a455496bb412ea49d004e

Sample Response:

{{\n    \"body\": {\n        \"results\": {\n            \"status\": \"completed\",\n            \"processed_event_instances\": \"1\",\n            \"scheduled_messages\": \"0\",\n            \"errors\": \"1\",\n            \"details\": {\n                \"listid\": \"50806\",\n                \"events\": {\n                    \"event_definition_id\": \"15532\",\n                    \"event_definition_name\": \"sample event\",\n                    \"event\": {\n                        \"event_instance_request_index\": \"0\",\n                        \"correlationid\": \"ABC567\",\n                        \"memberid\": \"86793779\",\n                        \"event_instance_id\": \"798831\",\n                        \"scheduled_messages\": null,\n                        \"errors\": {\n                            \"error\": {\n                                \"error_code\": \"ERR-EVENT-006\",\n                                \"error_message\": \"There are no active messages for the given event.\"\n                            }\n                        }\n                    }\n                }\n            }\n        }\n    }\n}\n\n

Event Upload Status

pending: This status indicates that the event has been placed but has not yet been picked up for processing. It is expected that the event will not remain in this status for an extended period.
\n
running: The event has been picked up and is actively being processed
\n
completed: This status signifies that the event has finished processing, and no further actions are required.
\n
not found: The request ID could not be located. This may happen if:
\n
- The request ID is invalid, or
  \n
- The entry has expired and is no longer stored
  \n
\n

The Event Upload API allows you to trigger events for members in your mPulse Mobile account. These events can schedule messages, update member attributes, and interact with workflows based on the event definitions configured in your account.

Headers:

Authorization: Your API key.
\n
Content-Type: application/json
\n
X-Ms-Async: true (Required for requests with more than 100 events.)
\n

Rate Limits

The Event Upload API is rate-limited at 100 requests per minute per account.
\n
If you require a higher rate limit, please contact your account team.
\n

Member Identification

Account Types and Acceptable Identifiers

Contact-Based Accounts

For accounts that use contact-based identifiers:

Acceptable Identifiers:
\n
- mobilephone (string)
  \n
- email (string)
  \n
- memberid (string)
  \n
- client_member_id (string)
  \n
\n
Note: You can use any of the above identifiers to identify members.
\n

UMI Accounts

For UMI (Unique Member Identifier) accounts:

Acceptable Identifiers:
\n
- client_member_id (string)
  \n
- memberid (string)
  \n
\n
Note: You must use client_member_id or memberid to identify members. Other identifiers such as mobilephone or email are not accepted.
\n

\n","_postman_id":"4b2f2920-4208-4ef8-a980-c3fbad9c8278","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"Event Upload API (XML)","item":[{"name":"Event Upload API - XML","item":[{"name":"Event Upload - Single Event","id":"63a430c8-87e5-4313-954e-6f53854f483b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Source","value":"api","type":"text"},{"key":"X-Ms-API-Version","value":"2.0","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"},{"key":"X-Ms-Format","value":"xml","type":"text"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\t\n\t\t13105551212\n ABC123\n\t\t\n\t\n"},"url":"https://ms-api.mpulsemobile.com/account/{{account_id}}/uploadEvent","description":"

Makes a single event request for a single member.

\n","urlObject":{"protocol":"https","path":["account","{{account_id}}","uploadEvent"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63a430c8-87e5-4313-954e-6f53854f483b"},{"name":"Event Upload - Multiple Events","id":"5876be21-5e8a-492a-8e3f-a300a28bec63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Source","value":"api","type":"text"},{"key":"X-Ms-API-Version","value":"2.0","type":"text"},{"key":"Content-Type","value":"application/xml","type":"text"},{"key":"X-Ms-Format","value":"xml","type":"text"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\t\n\t\t\t13105551212\n ABC123\n\t\t\n\t\t\n\t\t\tpolly_patient@hotmail.com\n ABC456\n\t\t\n\t\n"},"url":"https://ms-api.mpulsemobile.com/account/{{account_id}}/uploadEvent","description":"

Makes event requests for two or more members.

\n","urlObject":{"protocol":"https","path":["account","{{account_id}}","uploadEvent"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5876be21-5e8a-492a-8e3f-a300a28bec63"}],"id":"609a7473-d278-41ca-a249-78f045738b37","event":[{"listen":"prerequest","script":{"id":"8892826c-0157-49b6-be23-15f915e3c1d5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fbba3584-2c70-4ab3-9be8-8a04141fb4cc","type":"text/javascript","exec":[""]}}],"_postman_id":"609a7473-d278-41ca-a249-78f045738b37","description":"","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}}],"id":"58ef0750-98b1-432c-9a38-8d3e102974d2","description":"

Overview

Events are defined in the mPulse Communication Console and can be used to trigger actions. Most commonly, this would be to launch one or more one-way messages from a Campaign or to start a conversation (Dialogue) with a member. Events can also be used to stop dialogues.

Events can be configured with attributes, and the attributes can be used for evaluation and matching to trigger messages or other items. Attributes can also be used for passing event-related or transient data along with the message or dialogue. For example, you may wish to send appointment-related information such as a provider name, a date, and a time of the appointment. This information does not need to be stored on the member profile as it's only related to this single instance of an appointment.

Events can be configured across lists, campaigns, and messages. You can use the same event on multiple messages in the same campaign. If you fire an event for a given member, s/he will receive however many messages are configured and active on however many channels s/he is subscribed to. In other words, please be careful when configuring events, messages, and dialogues.

Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Required	Values	Description
`X-Ms-Source`	yes	`api`	N/A
`X-Ms-Format`	yes	`json` or `xml`	N/A
`Authentication`	no	Basic Auth (see Account team for your credentials )	You must use either the `Authentication` header or the `Access-Token` header (see below)
`Access-Token`	no	`{ACCESS_TOKEN}`	If using OAuth for authentication, the value is `{ACCESS_TOKEN}`; see the OAuth Documentation for instructions on how to get a password using the OAuth Password Grant API
`X-Ms-API-Version`	yes	`2.0`	N/A
`X-Ms-Verbosity`	no	`simple` (default) or `full`	`simple` response does not include original request; `full` includes original request
`X-Ms-Async`	no	`false` (default) or `true`	Sync processing allows for 20 stanzas per request; async processing allows up to 2,000 stanzas per request

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Scope	Name/Object	Required	Accepted Values & Description
`body`	`events`	yes	Describes the event definition the request is for. You can only make requests for a single event definition
`events`	`name`	yes	The name of the event in the mPulse platform. It is not case sensitive
`events`	`event`	yes	Describes a single event for a single member. Multiple event objects can be included in a single request
`event`	`scheduled_on`	yes	Accepted formats: YYYY-MM-DD HH:MM or +HH:MM - supports scheduling at a specific date and time or relative to when the request is processed (+HH:MM)
`event`	`timezone`	yes	A valid timezone must be provided. See Accepted Timezone Values
`event`	`evaluation_scope`	yes	`no_rule` or `with_rule` or `all` `no_rule` - uses only the event name when processing; `with_rule` - only messages with a trigger that specifies an event definition name and a rule based on an attribute that matches the event definition will be processed; `all` - all events will be processed
`event`	`memberid` or `mobilephone` or `email` or `client_member_id`	yes	Must include exactly one of the preceding identifiers; that member must exist in the system and be an active (non-deleted) member and subscribed to the list and channel specified in order to trigger an event/message
`event`	`correlationid`	no	Allows you to tag the event object for reporting; the correlation ID will show up in custom reporting for messages triggered from the event.
`event`	`{event_attribute_name1}`	no	Required if being used for triggering events based on matching rules and/or if you are using the event attribute in the token of a message
`body`	`list_id`	yes	Must be a valid list ID on your account. Members must be subscribed to that list in order to receive messages triggered by events.

Error Responses (400 OK)

These errors are provided at the highest level and indicate that the entire request has not been processed. You will only receive one error stanza at this level. The response is the same regardless of the value of the Full Verbosity header.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Error Message
ERR-EVNTS-000	The JSON or XML in the request could not be processed.
ERR-EVNTS-001	The `event_name` provided in the request does not exist in the account.
ERR-EVNTS-002	The `list_id` tag is either missing or does not contain a value.
ERR-EVNTS-003	The `list_id` does not exist in the account.
ERR-EVNTS-004	The `list_id` exists in the account, but it is not active/has been retired.

Note that an Event Upload API call may succeed (200 OK), but that the dialogue it's starting (or stopping) or the one-way message it's triggering may still fail downstream. For example, an event may be scheduled for two days in the future, and the member may unsubscribe between the time the Event Upload API call was made and the event triggers.

General Notes

To schedule an event immediately, make a request with scheduled_on set to +00:00, for example: \"scheduled_on\": +\"00:00\"

In this example, I have an event definition \"appointment_reminder\" with the attributes \"today\" and \"appointment_time.\" I want to set up my API call to only trigger appointments where the value of \"today\" equals \"true,\" and I have a campaign set up in Communication Console with a message that replaces the token ##EVENT.APPOINTMENT_TIME## with the value in appointment_time. I would make an API call like the following to trigger a message to my member:

{ \"body\": { \"events\": { \"name\": \"sample_event\", \"event\": { \"scheduled_on\": \"+00:00\", \"timezone\": \"US/Pacific\", \"evaluation_scope\": \"with_rule\", \"memberid\":1234567, \"today\": \"true\", \"appointment_time\": \"2:30pm\" } }, \"listid\": 1234 } }

Rate Limiting & Number of Stanzas in Requests

The Event Upload API is rate limited at 100 requests per minute per account. If this is not sufficient for your needs, please contact your account team to discuss.

You can perform actions on up to 2,000 members in a single request. You must have the X-Ms-Async: true header set.

\n","event":[{"listen":"prerequest","script":{"id":"0650285d-e132-4997-b1fb-2613c78b21ba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bc4d959b-052d-450e-a528-4978e1977b9c","type":"text/javascript","exec":[""]}}],"_postman_id":"58ef0750-98b1-432c-9a38-8d3e102974d2","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"DNC APIs","item":[{"name":"SMS","item":[{"name":"Review SMS DNC List","id":"aad4649e-e395-4b79-a31f-bcb0c38d3156","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://members.mpulsemobile.com/api/v1/accounts/{{account_id}}/block/sms?limit=25&offset=0","description":"

Retrieves a paginated list of phone numbers currently on the SMS Do Not Contact (DNC) list for the specified account.

Query Parameters

limit (optional, integer, default: _100_)
\n
- Specifies the number of records to return.
  \n
- Maximum allowed value is 1000.
  \n
\n
offset (optional, integer, default: _0_)
\n
- Specifies the number of records to skip for pagination.
  \n
- Use this to retrieve additional records beyond the initial set.
  \n
\n

Sample Response:

{\n    \"data\": [\n        {\n            \"id\": 23,\n            \"account_id\": 1458,\n            \"phone_number\": \"14027011112\",\n            \"created_on\": \"2022-02-04T21:28:13.504276Z\"\n        },\n        {\n            \"id\": 626,\n            \"account_id\": 1458,\n            \"phone_number\": \"19134878181\",\n            \"created_on\": \"2022-01-28T16:29:42.117731Z\"\n        },\n        {\n            \"id\": 3648,\n            \"account_id\": 1458,\n            \"phone_number\": \"16604732211\",\n            \"created_on\": \"2023-05-19T14:44:55.963239Z\"\n        },\n        {\n            \"id\": 3649,\n            \"account_id\": 1458,\n            \"phone_number\": \"16604732212\",\n            \"created_on\": \"2023-05-19T14:44:56.853639Z\"\n        },\n        {\n            \"id\": 7585,\n            \"account_id\": 1458,\n            \"phone_number\": \"19811490950\",\n            \"created_on\": \"2023-11-15T13:39:36.958449Z\"\n        }\n    ],\n    \"limit\": 5,\n    \"offset\": 0,\n    \"total\": 38231\n}\n\n

Adds an array of phone numbers to the SMS Do Not Contact (DNC) list, preventing SMS messages from being sent to them.

Sample Success Response:

status code: 202

{\n    \"status\": \"success\",\n    \"msg\": \"Block Request Accepted\"\n}\n\n

Sample Error Response (invalid phone number):

status code: 422

{\n    \"detail\": [\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                0\n            ],\n            \"msg\": \"Value error, Phone number is invalid - 9891918541\",\n            \"input\": \"9891918541\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        },\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                1\n            ],\n            \"msg\": \"Value error, Phone number is invalid - 2183039902\",\n            \"input\": \"2183039902\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        }\n    ]\n}\n\n

Removes an array of phone numbers from the SMS DNC list, allowing SMS messages to be sent to them again.

Sample Success Response:

status code: 202

{\n    \"status\": \"success\",\n    \"msg\": \"Unblock Request Accepted\"\n}\n\n

Sample Error Response (invalid phone number):

status code: 422

{\n    \"detail\": [\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                0\n            ],\n            \"msg\": \"Value error, Phone number is invalid - 9891918540\",\n            \"input\": \"9891918541\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        }\n    ]\n}\n\n

The SMS DNC API allows customers to manage a Do Not Contact (DNC) list for SMS communications within their mPulse account. By adding phone numbers to this list, all SMS messages to those numbers are blocked. Similarly, removing a number from the list allows SMS communications to resume.

\n","_postman_id":"036878e4-9cf0-46ec-bd98-895abfd665cb","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"IVR","item":[{"name":"Review IVR DNC List","id":"c00125c4-24e5-481d-a550-6243b5f6284d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://members.mpulsemobile.com/api/v1/accounts/{{account_id}}/block/ivr?limit=25&offset=0","description":"

Retrieves a paginated list of phone numbers currently on the IVR Do Not Contact (DNC) list for the specified account.

Query Parameters

limit (optional, integer, default: _100_)
\n
- Specifies the number of records to return.
  \n
- Maximum allowed value is 1000.
  \n
\n
offset (optional, integer, default: _0_)
\n
- Specifies the number of records to skip for pagination.
  \n
- Use this to retrieve additional records beyond the initial set.
  \n
\n

Sample Response:

{\n    \"data\": [\n        {\n            \"id\": 23,\n            \"account_id\": 1458,\n            \"phone_number\": \"14027011112\",\n            \"created_on\": \"2022-02-04T21:28:13.504276Z\"\n        },\n        {\n            \"id\": 626,\n            \"account_id\": 1458,\n            \"phone_number\": \"19134878181\",\n            \"created_on\": \"2022-01-28T16:29:42.117731Z\"\n        },\n        {\n            \"id\": 3648,\n            \"account_id\": 1458,\n            \"phone_number\": \"16604732211\",\n            \"created_on\": \"2023-05-19T14:44:55.963239Z\"\n        },\n        {\n            \"id\": 3649,\n            \"account_id\": 1458,\n            \"phone_number\": \"16604732212\",\n            \"created_on\": \"2023-05-19T14:44:56.853639Z\"\n        },\n        {\n            \"id\": 7585,\n            \"account_id\": 1458,\n            \"phone_number\": \"19811490950\",\n            \"created_on\": \"2023-11-15T13:39:36.958449Z\"\n        }\n    ],\n    \"limit\": 5,\n    \"offset\": 0,\n    \"total\": 38231\n}\n\n

Adds an array of phone numbers to the IVR DNC list, blocking IVR calls sent to that member.

Sample Success Response:

status code: 202

{\n    \"status\": \"success\",\n    \"msg\": \"Block Request Accepted\"\n}\n\n

Sample Error Response (invalid phone number):

status code: 422

{\n    \"detail\": [\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                0\n            ],\n            \"msg\": \"Value error, Phone number is invalid - 9891918541\",\n            \"input\": \"9891918541\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        },\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                1\n            ],\n            \"msg\": \"Value error, Phone number is invalid - 2183039902\",\n            \"input\": \"2183039902\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        }\n    ]\n}\n\n

Removes an array of phone numbers to the IVR DNC list, allowing calls to be sent to that number.

Sample Success Response:

status code: 202

{\n    \"status\": \"success\",\n    \"msg\": \"Unblock Request Accepted\"\n}\n\n

Sample Error Response (invalid phone number):

status code: 422

{\n    \"detail\": [\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                0\n            ],\n            \"msg\": \"Value error, Phone number is invalid - 9891918540\",\n            \"input\": \"9891918541\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        }\n    ]\n}\n\n

The IVR DNC API allows customers to manage a Do Not Contact (DNC) list for IVR communications within their mPulse account. By adding phone numbers to this list, all IVR calls to those numbers are blocked. Similarly, removing a number from the list allows IVR communications to resume.

\n","_postman_id":"fef2e49a-a4d3-4644-a271-8a98a6fd9ded","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"Email","item":[{"name":"Review Email DNC List","id":"eece99d5-5f24-41d3-8a71-2c3bd3090a0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://members.mpulsemobile.com/api/v1/accounts/{{account_id}}/block/email?limit=25&offset=0","description":"

Retrieves a paginated list of email addresses currently on the email Do Not Contact (DNC) list for the specified account.

Query Parameters

limit (optional, integer, default: _100_)
\n
- Specifies the number of records to return.
  \n
- Maximum allowed value is 1000.
  \n
\n
offset (optional, integer, default: _0_)
\n
- Specifies the number of records to skip for pagination.
  \n
- Use this to retrieve additional records beyond the initial set.
  \n
\n

Sample Response:

{\n    \"data\": [\n        {\n            \"id\": 9830,\n            \"account_id\": 1458,\n            \"email\": \"test_email_pulse2@yopmail.com\",\n            \"created_on\": \"2023-11-15T14:10:36.242818Z\"\n        },\n        {\n            \"id\": 9831,\n            \"account_id\": 1458,\n            \"email\": \"sam1458test@yopmail.com\",\n            \"created_on\": \"2023-11-15T16:43:56.698079Z\"\n        },\n        {\n            \"id\": 10748,\n            \"account_id\": 1458,\n            \"email\": \"mish_a9@yopmail.com\",\n            \"created_on\": \"2024-08-01T21:43:51.917842Z\"\n        },\n        {\n            \"id\": 10914,\n            \"account_id\": 1458,\n            \"email\": \"test_email_pulse2_12345@yopmail.com\",\n            \"created_on\": \"2025-01-17T06:45:19.386712Z\"\n        },\n        {\n            \"id\": 10922,\n            \"account_id\": 1458,\n            \"email\": \"1234\",\n            \"created_on\": \"2025-01-17T07:36:26.171227Z\"\n        }\n    ],\n    \"limit\": 5,\n    \"offset\": 0,\n    \"total\": 60047\n}\n\n

Adds an array of email addresses to the Email DNC list, blocking emails from being sent to that address.

Sample Success Response:

status code: 202

{\n    \"status\": \"success\",\n    \"msg\": \"Block Request Accepted\"\n}\n\n

Sample Error Response (invalid email):

status code: 422

{\n    \"detail\": [\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                0\n            ],\n            \"msg\": \"Value error, Email is invalid - nakul.sharma@emids\",\n            \"input\": \"nakul.sharma@emids\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        },\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                1\n            ],\n            \"msg\": \"Value error, Email is invalid - asas@yifan.shen@mpulse.com\",\n            \"input\": \"asas@yifan.shen@mpulse.com\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        }\n    ]\n}\n\n

Removes an array of email addresses from the Email DNC list, allowing emails to be sent to that email address on the given account.

Sample Success Response:

status code: 202

{\n    \"status\": \"success\",\n    \"msg\": \"Unblock Request Accepted\"\n}\n\n

Sample Error Response (invalid email):

status code: 422

{\n    \"detail\": [\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                0\n            ],\n            \"msg\": \"Value error, Email is invalid - nakul.sharma@emids\",\n            \"input\": \"nakul.sharma@emids\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        },\n        {\n            \"type\": \"value_error\",\n            \"loc\": [\n                \"body\",\n                1\n            ],\n            \"msg\": \"Value error, Email is invalid - asas@yifan.shen@mpulse.com\",\n            \"input\": \"asas@yifan.shen@mpulse.com\",\n            \"ctx\": {\n                \"error\": {}\n            }\n        }\n    ]\n}\n\n

The Email DNC API allows customers to manage a Do Not Contact (DNC) list for Email communications within their mPulse account. By adding email addresses to this list, all emails to those email addresses are blocked. Similarly, removing an email from the list allows email communications to resume.

\n","_postman_id":"137eb847-20d1-46eb-b7ce-bea20e2778e4","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}}],"id":"c7de82f1-b456-4d52-8447-074ea4ed37ad","description":"

Introduction

The mPulse Mobile DNC (Do Not Contact) APIs allow customers to programmatically manage their organization’s DNC list for SMS, Email, and IVR. These APIs ensure compliance with member communication preferences and regulatory frameworks by blocking outbound messages to specific contact identifiers.

Once an identifier (e.g., phone number or email) is added to a DNC list, any messages sent through mPulse to that identifier are automatically suppressed. This applies across all programs and campaigns in the account.

Channels Supported

SMS Block API
\n
Email Block API
\n
IVR Block API
\n

Each channel has its own endpoint and supports the same set of operations: retrieving entries, adding entries, removing entries, and handling bulk requests.

\n","_postman_id":"c7de82f1-b456-4d52-8447-074ea4ed37ad","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"Oauth 2.0","item":[{"name":"Obtain Oauth Token","id":"ea166134-b204-42ee-9f7c-8f50ebc90cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://auth.mpulsemobile.com/oauth/token","description":"

Request Headers

Content-Type: application/json

Request Body

Provide your client_id and client_secret in JSON format. You can obtain your client_id and client_secret from your mPulse implemention team.

{\n    \"client_id\": \"YOUR_CLIENT_ID\",\n    \"client_secret\": \"YOUR_CLIENT_SECRET\"\n}\n\n

Response

A successful response will include an access_token and other relevant information:

{\n    \"client_id\": \"7081b7c7-4c4b-41b8-96b9-2901a3224fd3\",\n    \"account_id\": 1992,\n    \"issued_at\": 1728320449,\n    \"expires_at\": 1728324049,\n    \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXmsK-qcFqE3ybz23xbdiWceYN1FrkF2j9LbxG6X7dGVA\"\n}\n\n

Response Parameters:

client_id: Your client identifier.
\n
account_id: Your account identifier.
\n
issued_at: The timestamp when the token was issued (in Unix epoch time).
\n
expires_at: The timestamp when the token will expire (in Unix epoch time).
\n
access_token: The token to be used for authenticating API requests.
\n

After obtaining the access token, you can verify its validity at any time.

Request Headers

Content-Type: application/json

Request Body

Provide your access_token, ip_address, and account_id:

{\n    \"access_token\": \"YOUR_ACCESS_TOKEN\",\n    \"ip_address\": \"YOUR_IP_ADDRESS\",\n    \"account_id\": \"YOUR_ACCOUNT_ID\"\n}\n\n

Response

A successful response will confirm the validity of your token:

{\n    \"success\": true,\n    \"issued_at\": 1728320449,\n    \"expires_at\": 1728324049\n}\n\n

Response Parameters:

success: Indicates whether the token is valid (trueor false).
\n
issued_at: The timestamp when the token was issued.
\n
expires_at: The timestamp when the token will expire.
\n

You can access our APIs using Oauth 2.0 alongside basic authentication.

OAuth 2.0 is an industry-standard protocol for authorization that allows applications to obtain access to user accounts on an HTTP service. This guide will help you:

Obtain an access token using your client_id and client_secret.
\n
- This information will be provided by your mPulse Implementation team.
\n
Verify the validity of your access token.
\n
Use the access token to authenticate API requests.
\n

\n","_postman_id":"7e625087-80e3-484f-89ed-75a73d7b4bdf","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"Callbacks","item":[{"name":"Member","item":[{"name":"ADD (v3.0)","item":[],"id":"c5dc1a2a-14b2-47f1-afde-209b0219ef43","description":"

Purpose

ADD fires whenever a new member record is created in your account and is pushed to your registered callback (webhook) URL. It delivers key profile details so downstream systems can immediately begin messaging, personalization, or data-sync workflows.

Payload Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`member_id`	integer	Internal system ID (immutable).
`client_member_id`	string	Your external reference / foreign key.
`first_name`	string	Optional; can be empty.
`last_name`	string	Optional; can be empty.
`email`	string	Validated email if supplied.
`mobile_phone_number`	string	E.164 format recommended (e.g., `+19096143073`).
`carrier`	string	Detected or user-supplied mobile carrier.
`api_username`	string	Credential that initiated the create call.
`action`	string	Constant = `\"ADD\"`.
`request_datetime`	string	UTC or provided timezone in `YYYY-MM-DD HH:MM:SS TZ` format.

Example Payloads

{\n  \"member_id\": 152819911,\n  \"email\": \"fake@email.com\",\n  \"first_name\": \"Kyle\",\n  \"last_name\": \"Blanchard\",\n  \"mobile_phone_number\": \"19095551234\",\n  \"client_member_id\": \"oalskc9y12e3on12\",\n  \"carrier\": \"AT&T\",\n  \"api_username\": \"Sales Engineering Demo\",\n  \"action\": \"ADD\",\n  \"request_datetime\": \"2025-05-17 14:28:57 MST\"\n}\n\n

<body>\n  <message>\n    <member_id>152819914</member_id>\n    <email>bklcnahbw@email.com</email>\n    <first_name>John</first_name>\n    <last_name>Doe</last_name>\n    <client_member_id>asqw1412</client_member_id>\n    <api_username>Account Demo</api_username>\n    <action>ADD</action>\n    <request_datetime>2025-05-17 14:30:02 MST</request_datetime>\n  </message>\n</body>\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a37d5c57-4eaa-4487-9dcc-9dc842242b86","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"9b20db30-fe2f-4fc9-9b8b-d61dd3c82800","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"c5dc1a2a-14b2-47f1-afde-209b0219ef43"},{"name":"UPDATE (v2.0)","item":[],"id":"bd7ccb6b-844c-44b2-a4e4-4cb3267665f5","description":"

Purpose

UPDATE notifies your system whenever an existing member record's data changes—whether custom field or standard field.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`member_id`	integer	Internal ID.
`client_member_id`	string	Your external reference.
`first_name` / `last_name`	string	Present only if changed.
`email`	string	Present only if changed.
`mobile_phone_number`	string	Present only if changed (E.164).
`carrier`	string	Present if updated or newly discovered.
	variable	Any number of additional keys fields can appear—exact names come from the user-defined custom schema and are included only when that field was created or updated in this event. Note - when updating from UI, fields may be considered \"updated\" even without changing the value. Examples: `appointment_type`, `preferred_language`, `risk_score`, etc.
`action`	string	`\"UPDATE\"`.
`request_datetime`	string	Timestamp with timezone.

JSON

{\n  \"member_id\": 152819911,\n  \"client_member_id\": \"oalskc9y12e3on12\",\n  \"email\": \"fake@email.com\",\n  \"mobile_phone_number\": \"19095555521\",\n  \"carrier\": \"AT&T\",\n  \"appointment_date\": \"2025-05-22\",\n  /* ─── Custom fields (names vary per tenant) ─── */\n  \"appointment_type\": \"Mammogram\",\n  \"exists\": \"True\",\n  \"selected_channel\": \"none\",\n  \"selected_topic\": \"none\",\n  \"preferred_language\": \"es\",\n  \"risk_score\": 7.6,\n  /* ───────────────────────────────────────────── */\n  \n  \"action\": \"UPDATE\",\n  \"request_datetime\": \"2025-05-17 14:38:02 MST\"\n}\n\n

XML

<body>\n  <message>\n    <member_id>152819911</member_id>\n    <client_member_id>oalskc9y12e3on12</client_member_id>\n    <email>fake@email.com</email>\n    <mobile_phone_number>19095552142</mobile_phone_number>\n    <carrier>AT&amp;T</carrier>\n    <appointment_date>2025-05-22</appointment_date>\n    <!-- ── Custom fields (names vary per tenant) ── -->\n    <appointment_type>Mammogram</appointment_type>\n    <exists>True</exists>\n    <selected_channel>none</selected_channel>\n    <selected_topic>none</selected_topic>\n    <preferred_language>es</preferred_language>\n    <risk_score>7.6</risk_score>\n    <!-- ─────────────────────────────────────────── -->\n    <action>UPDATE</action>\n    <request_datetime>2025-05-17 14:38:02 MST</request_datetime>\n  </message>\n</body>\n\n

\n","_postman_id":"bd7ccb6b-844c-44b2-a4e4-4cb3267665f5","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"BULKADD (v2.0)","item":[],"id":"a35677bd-5b64-4efc-ba5f-795e02676295","description":"

Purpose

The BULKADD callback is an asynchronous response issued when a bulk member add/update request is processed via the Audience API with the header X-Ms-Async=true. This callback includes successes, failures, metadata, and error details for each individual member submitted in the request.

XML Example

<body>\n  <msg>\n    <REQUEST_ID>Z62942438-53b6-437e-a68b-c238389e09ec</REQUEST_ID>\n    <HTTP_STATUS>202</HTTP_STATUS>\n    <RESPONSE>\n      <body>\n        <results>\n          <success>1</success>\n          <failure>1</failure>\n        </results>\n        <xml_errors />\n        <members>\n          <member>\n            <id>\n              <mobilephone>17147579780</mobilephone>\n              <memberid>111173385</memberid>\n              <clientmemberid>MP000111333X</clientmemberid>\n            </id>\n            <result>success</result>\n            <profile>\n              <DATEADDED>2025-05-17 08:08 PDT</DATEADDED>\n              <FIRSTNAME>John</FIRSTNAME>\n              <LASTNAME>Doe</LASTNAME>\n              <MOBILEPHONE>17147579780</MOBILEPHONE>\n              <CLIENTMEMBERID>MP000111333X</CLIENTMEMBERID>\n              <REMENALED>False</REMENALED>\n            </profile>\n          </member>\n          <member>\n            <id>\n              <mobilephone>14076009177</mobilephone>\n              <memberid>111173385</memberid>\n            </id>\n            <result>failure</result>\n            <member_errors>\n              <member_error>\n                <code>MS-ERR-0803</code>\n                <message>Invalid parameter value</message>\n                <detail>\n                  <parameter>clientmemberid</parameter>\n                  <value>MP000111333X</value>\n                  <reason>not_unique</reason>\n                </detail>\n              </member_error>\n            </member_errors>\n          </member>\n        </members>\n      </body>\n    </RESPONSE>\n    <ACTION>BULKADD</ACTION>\n  </msg>\n</body>\n\n

\n","_postman_id":"a35677bd-5b64-4efc-ba5f-795e02676295","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}}],"id":"f6d0c172-864e-43b9-8060-23d05e1c696d","_postman_id":"f6d0c172-864e-43b9-8060-23d05e1c696d","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"SMS","item":[{"name":"SUB (v3.1)","item":[],"id":"11f659f9-a164-4e66-8e45-8dcc7c184e69","description":"

Purpose

The SUB callback notifies your system when a member opts in to receive SMS communications for a specific list. This can happen via keyword, web form, or other configured entry points. Version 3.1 introduces list-level filtering and API inclusion/exclusion logic, offering more granular control over which subscriptions trigger callbacks.

Payload Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`mobile_phone_number`	string	E.164 format preferred (e.g., `+19096143073`)
`list_id`	integer	The unique ID of the SMS list the member subscribed to
`member_id`	integer	Internal system ID for the member
`client_member_id`	string	Your external reference key
`request_datetime`	string	Timestamp of the event with timezone
`correlation_id`	string or null	Used to correlate with original requests (may be null)
`api_username`	string or null	The user that performed the API-triggered opt-in (null if opt-in came from self-service or keyword)
`action`	string	Always `\"SUB\"`

Example Payloads

JSON

{\n  \"mobile_phone_number\": \"19095555182\",\n  \"list_id\": 32918,\n  \"member_id\": 152819914,\n  \"client_member_id\": \"asqw1412\",\n  \"request_datetime\": \"2025-05-17 14:58:38.874518 MST\",\n  \"correlation_id\": null,\n  \"api_username\": null,\n  \"action\": \"SUB\"\n}\n\n

XML

<body>\n  <message>\n    <mobile_phone_number>190955521431</mobile_phone_number>\n    <list_id>33092</list_id>\n    <member_id>152819914</member_id>\n    <client_member_id>asqw1412</client_member_id>\n    <request_datetime>2025-05-17 14:59:05.584413 MST</request_datetime>\n    <correlation_id />\n    <api_username />\n    <action>SUB</action>\n  </message>\n</body>\n\n

\n","_postman_id":"11f659f9-a164-4e66-8e45-8dcc7c184e69","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"UNSUB (v3.1)","item":[],"id":"f527dcc5-4402-493f-a41f-c80c5b04afef","description":"

Purpose

The UNSUB callback notifies your system when a member opts out of receiving SMS communications for a specific list. This may happen via keyword (e.g., STOP), link-click, or other configured unsubscribe workflows.

Version 3.1 supports:

List-specific callback configuration
\n
Excluding or including API-originated opt-outs
\n

Payload Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`mobile_phone_number`	string	Member’s phone in E.164 format
`list_id`	integer	The SMS list the member opted out from
`member_id`	integer	Internal system ID for the member
`client_member_id`	string	External reference ID
`request_datetime`	string	Timestamp of unsubscribe with sub-second precision
`correlation_id`	string or null	Used for attribution or campaign tracking
`api_username`	string or null	Populated only if opt-out occurred via authenticated API call
`action`	string	Always `\"UNSUB\"`

Example Payloads

JSON

{\n  \"mobile_phone_number\": \"15554443333\",\n  \"list_id\": 44221,\n  \"member_id\": 918273645,\n  \"client_member_id\": \"xzy123clientref\",\n  \"request_datetime\": \"2025-05-17 15:02:09.239690 MST\",\n  \"correlation_id\": null,\n  \"api_username\": null,\n  \"action\": \"UNSUB\"\n}\n\n

XML

<body>\n  <message>\n    <mobile_phone_number>15554443333</mobile_phone_number>\n    <list_id>44221</list_id>\n    <member_id>918273645</member_id>\n    <client_member_id>xzy123clientref</client_member_id>\n    <request_datetime>2025-05-17 15:02:39.741578 MST</request_datetime>\n    <correlation_id />\n    <api_username />\n    <action>UNSUB</action>\n  </message>\n</body>\n\n

\n","_postman_id":"f527dcc5-4402-493f-a41f-c80c5b04afef","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"MT (v1.0)","item":[],"id":"1056f6db-0e70-4ae9-9c46-4810fd61536c","description":"

Purpose

The MT (Mobile-Terminated) callback notifies your system whenever an outgoing SMS message is sent to a consumer. It provides full delivery context—message content, shortcode, segment count, and tracking metadata.

Fully supports message send notifications
\n
No retry status or delivery receipt—this is fire-on-send only
\n
List-based filtering and usage-based licensing required for scale
\n

Payload Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`timestamp`	string	When the message was sent (`YYYY-MM-DD HH:MM:SS TZ`)
`tracking_id`	integer	Unique identifier for this send event
`audience_member_id`	integer	Internal ID of the recipient
`message_id`	integer or null	Internal ID if known (null for dynamic/unbatched messages)
`phone_number`	string	Recipient's phone number
`shortcode`	integer	Shortcode used to send the message
`account_id`	integer	ID of the sending account
`list_id`	integer	List associated with this message send
`correlation_id`	string or null	Optional value for mapping to a campaign, journey, or external event
`segment_count`	integer	Number of SMS segments used
`carrier`	string or null	Carrier if resolved (may be null)
`content`	string	The exact text sent to the consumer
`action`	string	Constant = `\"MT\"`

Example Payloads

JSON

{\n  \"timestamp\": \"2025-05-17 15:07:15 MST\",\n  \"tracking_id\": 1177520876,\n  \"audience_member_id\": 152819914,\n  \"message_id\": null,\n  \"phone_number\": \"15556667777\",\n  \"shortcode\": 98908,\n  \"account_id\": 1267,\n  \"list_id\": 12189,\n  \"correlation_id\": null,\n  \"segment_count\": 1,\n  \"carrier\": \"T-Mobile\",\n  \"content\": \"Track Outcome Demo v2 - Initial -- Reply YES or NO\",\n  \"action\": \"MT\"\n}\n\n

XML (Spoofed Example)

<body>\n  <message>\n    <timestamp>2025-05-17 15:08:15 MST</timestamp>\n    <tracking_id>1177520896</tracking_id>\n    <audience_member_id>152819914</audience_member_id>\n    <message_id />\n    <phone_number>15556667777</phone_number>\n    <shortcode>98908</shortcode>\n    <account_id>1267</account_id>\n    <list_id>12189</list_id>\n    <correlation_id />\n    <segment_count>1</segment_count>\n    <carrier>T-Mobile</carrier>\n    <content>Track Outcome Demo v2 - Initial -- Reply YES or NO</content>\n    <action>MT</action>\n  </message>\n</body>\n\n

\n","_postman_id":"1056f6db-0e70-4ae9-9c46-4810fd61536c","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"MO (v2.0)","item":[],"id":"f85c2468-e1c3-46aa-85f7-ad9802729975","description":"

Purpose

The MO (Mobile-Originated) callback informs your system whenever a member replies to a message or sends an inbound SMS or MMS to your shortcode. This callback enables real-time response tracking, campaign logic, and data collection for interactive programs.

Payload Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`short_code`	string	The shortcode that received the message
`mobile_phone_number`	string	Sender’s phone number in E.164 format
`content`	string	Raw text message content
`carrier`	string	Sender’s mobile carrier
`mms_urls`	array	If an MMS was sent, includes array of media URLs; empty for SMS
`received_datetime`	string	Timestamp when message was received
`mo_id`	integer	Unique ID for this inbound message
`list_id`	integer	List associated with the interaction (if configured)
`campaign_id`	integer or null	Populated if part of a tracked campaign
`message_id`	integer or null	Outbound message ID this is a response to (if known)
`correlation_id`	string or null	Optional trace key from the originating journey
`client_member_id`	string	External reference ID
`member_id`	integer	Internal member ID
`action`	string	Always `\"MO\"`

Example Payloads

JSON

{\n  \"short_code\": \"98908\",\n  \"mobile_phone_number\": \"15554443333\",\n  \"content\": \"Yes, I’d like more info.\",\n  \"carrier\": \"T-Mobile\",\n  \"mms_urls\": [],\n  \"received_datetime\": \"2025-05-17 15:11:19.325093 MST\",\n  \"mo_id\": 61530944,\n  \"list_id\": 12189,\n  \"campaign_id\": null,\n  \"message_id\": null,\n  \"correlation_id\": null,\n  \"client_member_id\": \"xzy123clientref\",\n  \"member_id\": 918273645,\n  \"action\": \"MO\"\n}\n\n

XML

<body>\n  <message>\n    <short_code>98908</short_code>\n    <mobile_phone_number>15554443333</mobile_phone_number>\n    <content>Yep, sounds good</content>\n    <carrier>T-Mobile</carrier>\n    <mms_urls />\n    <received_datetime>2025-05-17 15:11:52.153435 MST</received_datetime>\n    <mo_id>61530947</mo_id>\n    <list_id>12189</list_id>\n    <campaign_id />\n    <message_id />\n    <correlation_id />\n    <client_member_id>xzy123clientref</client_member_id>\n    <member_id>918273645</member_id>\n    <action>MO</action>\n  </message>\n</body>\n\n

\n","_postman_id":"f85c2468-e1c3-46aa-85f7-ad9802729975","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"DR (v3.0)","item":[],"id":"0ed7c766-116d-4ae6-a449-8cb0b9894b96","description":"

Purpose

The DR (Delivery Report) callback is used to inform your system about the delivery outcome of an outgoing SMS message. It provides structured status and reason codes, message tracking info, and identifies the source of the delivery response (carrier or gateway).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Description
campaign_id	ID of the campaign this message belongs to.
request_datetime	Timestamp when DR was received. Format: `YYYY-MM-DD HH:MM:SS.ssssss TZD`.
action	Always `\"DR\"`
message_id	ID of the associated MT message.
list_id	Associated list ID (only included if list-level DR is enabled).
report_details	Wrapper for delivery metadata.
mobile_phone_number	Recipient's phone number.
status_code	High-level status: • 2: Deleted • 3: Undelivered • 4: Rejected • 5: Unknown • 6: Expired
reason_code	Detailed result corresponding to SMPP codes
status_text	Raw carrier/gateway report string.
client_member_id	External identifier (e.g., MRN, internal CRM ID).
member_id	Internal mPulse Member ID.
report_from	Source of DR: `\"CARRIER\"` or `\"SMS-GATEWAY\"`

JSON Example

{\n  \"body\": {\n    \"campaign_id\": 88221,\n    \"request_datetime\": \"2025-05-17 15:18:42.123456 MST\",\n    \"action\": \"DR\",\n    \"message_id\": 1177520876,\n    \"list_id\": 12189,\n    \"report_details\": {\n      \"mobile_phone_number\": \"15556667777\",\n      \"status_code\": 3,\n      \"reason_code\": 0,\n      \"status_text\": \"id:16cd06005e123456 sub:001 dlvrd:001 submit date:1704041534 done date:1704041534 stat:UNDELIV err:000 Text:N/A\",\n      \"client_member_id\": \"external-111\",\n      \"member_id\": 152819914,\n      \"report_from\": \"CARRIER\"\n    }\n  }\n}\n\n

XML Example

<body>\n  <message>\n    <campaign_id>88221</campaign_id>\n    <request_datetime>2025-05-17 15:18:42.123456 MST</request_datetime>\n    <action>DR</action>\n    <message_id>1177520876</message_id>\n    <list_id>12189</list_id>\n    <report_details>\n      <mobile_phone_number>15556667777</mobile_phone_number>\n      <status_code>3</status_code>\n      <reason_code>0</reason_code>\n      <status_text>\n        id:16cd06005e123456 sub:001 dlvrd:001 submit date:1704041534 done date:1704041534 stat:UNDELIV err:000 Text:N/A\n      </status_text>\n      <client_member_id>external-111</client_member_id>\n      <member_id>152819914</member_id>\n      <report_from>CARRIER</report_from>\n    </report_details>\n  </message>\n</body>\n\n

\n","_postman_id":"0ed7c766-116d-4ae6-a449-8cb0b9894b96","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"BOUNCE (v3.0)","item":[],"id":"4cbbc341-3517-4548-a407-11f18958a879","description":"

Purpose

The BOUNCE callback in version 3.0 provides detailed notifications when a message fails to deliver due to a hard or soft bounce. This version includes bounce type classification and is configurable to include:

Only HARD bounces (permanent delivery failure)
\n
Only SOFT bounces (temporary issues)
\n
Or both
\n

JSON

{\n  \"body\": {\n    \"message\": {\n      \"mobile_phone_number\": \"15558889999\",\n      \"short_code\": \"57889\",\n      \"client_member_id\": \"tester_9912\",\n      \"bounced_on_datetime\": \"2025-05-17 15:35:45\",\n      \"member_id\": 88991234,\n      \"message_id\": 129998,\n      \"bounce_type\": \"HARD\",  // or \"SOFT\"\n      \"action\": \"BOUNCE\"\n    }\n  }\n}\n\n

XML

<body>\n  <message>\n    <mobile_phone_number>15558889999</mobile_phone_number>\n    <short_code>57889</short_code>\n    <client_member_id>tester_9912</client_member_id>\n    <bounced_on_datetime>2025-05-17 15:35:45</bounced_on_datetime>\n    <member_id>88991234</member_id>\n    <message_id>129998</message_id>\n    <bounce_type>HARD</bounce_type> \n    <action>BOUNCE</action>\n  </message>\n</body>\n\n

\n","_postman_id":"4cbbc341-3517-4548-a407-11f18958a879","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}}],"id":"17de0448-b5b2-4588-b10f-54a5f8e7685b","_postman_id":"17de0448-b5b2-4588-b10f-54a5f8e7685b","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"EMAIL","item":[{"name":"EMAIL SUB (v2.0)","item":[],"id":"c47d04bd-9b99-45bb-9041-5ba751f1f71e","description":"

Description

Triggered when a member subscribes to an email list, regardless of whether via API, import, or UI. Can be configured to only trigger for specific lists.

Possible values for source: API | CLICK_EMAIL_LINK | CSV_UPLOAD | EDITOR_CHANGE

JSON Example

{\n  \"email_address\": \"john.doe@gmail.com\",\n  \"audience_member_id\": 8100892,\n  \"client_member_id\": \"MP000111777\",\n  \"sent_from_email_address\": \"noreply@mpulsemobile.com\",\n  \"request_timestamp\": \"2025-05-17 12:15:34.422611-07:00\",\n  \"correlation_id\": \"123GHJ\", \n  \"source_type\": \"API\",\n  \"list_id\": 3322,\n  \"action\": \"EMAIL SUB\"\n}\n\n

XML Example

<body>\n  <message>\n    <email_address>john.doe@gmail.com</email_address>\n    <audience_member_id>8100892</audience_member_id>\n    <client_member_id>MP000111777</client_member_id>\n    <sent_from_email_address>noreply@mpulsemobile.com</sent_from_email_address>\n    <request_timestamp>2025-05-17 12:15:34.422611-07:00</request_timestamp>\n    <source_type>API</source_type>\n    <correlation_id>123GHJ</correlation_id>\n    <list_id>3322</list_id>\n    <action>EMAIL SUB</action>\n  </message>\n</body>\n\n

\n","_postman_id":"c47d04bd-9b99-45bb-9041-5ba751f1f71e","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"EMAIL UNSUB (v2.0)","item":[],"id":"7bff8087-7513-4504-ac6c-d1de3d717ca3","description":"

Email Unsubscribe Callback (EMAIL UNSUB) – v2.0

Description

Fires when a member unsubscribes from email communication from a specific list.

JSON Example

{\n  \"email_address\": \"john.doe@gmail.com\",\n  \"audience_member_id\": 8100892,\n  \"client_member_id\": \"MP000111777\",\n  \"sent_from_email_address\": \"noreply@mpulsemobile.com\",\n  \"request_timestamp\": \"2025-05-17 12:22:01.235122-07:00\",\n  \"source_type\": \"CLICK_EMAIL_LINK\",\n  \"correlation_id\": \"123GHJ\",\n  \"list_id\": 3322,\n  \"action\": \"EMAIL UNSUB\"\n}\n\n

XML Example

<body>\n  <message>\n    <email_address>john.doe@gmail.com</email_address>\n    <audience_member_id>8100892</audience_member_id>\n    <client_member_id>MP000111777</client_member_id>\n    <sent_from_email_address>noreply@mpulsemobile.com</sent_from_email_address>\n    <request_timestamp>2025-05-17 12:22:01.235122-07:00</request_timestamp>\n    <source_type>CLICK_EMAIL_LINK</source_type>\n    <correlation_id>123GHJ</correlation_id>\n    <list_id>3322</list_id>\n    <action>EMAIL UNSUB</action>\n  </message>\n</body>\n\n

\n","_postman_id":"7bff8087-7513-4504-ac6c-d1de3d717ca3","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}},{"name":"EMAIL OPEN (v2.0)","item":[],"id":"779d9097-e012-477a-93d5-83367b760218","description":"

Description

Occurs each time an email is opened, enabling engagement tracking.

JSON Example

{\n  \"email_address\": \"john.doe@gmail.com\",\n  \"audience_member_id\": 8100892,\n  \"client_member_id\": \"MP000111777\",\n  \"sent_from_email_address\": \"noreply@mpulsemobile.com\",\n  \"timestamp\": \"2025-05-17 13:00:11.429133-07:00\",\n  \"message_id\": 81763,\n  \"list_id\": 3322,\n  \"email_sent_id\": 1790636,\n  \"correlation_id\": null,\n  \"action\": \"EMAIL OPEN\"\n}\n\n

XML Example

<body>\n  <message>\n    <email_address>john.doe@gmail.com</email_address>\n    <audience_member_id>8100892</audience_member_id>\n    <client_member_id>MP000111777</client_member_id>\n    <sent_from_email_address>noreply@mpulsemobile.com</sent_from_email_address>\n    <timestamp>2025-05-17 13:00:11.429133-07:00</timestamp>\n    <message_id>81763</message_id>\n    <list_id>3322</list_id>\n    <email_sent_id>1790636</email_sent_id>\n    <correlation_id />\n    <action>EMAIL OPEN</action>\n  </message>\n</body>\n\n

\n","_postman_id":"779d9097-e012-477a-93d5-83367b760218","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}}],"id":"11eb6c4f-5885-42e7-85e6-a7007de23f3a","_postman_id":"11eb6c4f-5885-42e7-85e6-a7007de23f3a","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","name":"Callbacks","type":"folder"}}}],"id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23","description":"

Introduction

Callbacks are real-time webhook events that Program Manager fires whenever a key action occurs — for example, a member subscribes to an SMS list, an email bounces, or a member opts out. Instead of pulling reports or waiting for overnight files, your downstream systems receive the event instantly, letting you:

Sync data in near-real-time → update CRMs, EHRs, data lakes, etc.
\n
Create dynamic integration → enroll a member in a new program, open a ticket, send a confirmation message.
\n

You can manage callback endpoints:

Self-service – Program Manager UI (requires a Program Manager licence).
\n
Managed – the mPulse team can create, change, or disable callbacks on your behalf (may require additional license)
\n

Supported Authentication Methods

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	How it works	When to use
OAuth 2.0 (Client-Credentials)	Program Manager fetches a bearer token from your auth server and attaches `Authorization: Bearer` to every POST.	Best for enterprise APIs that rotate tokens automatically.
Static Bearer	You supply a long-lived bearer token; Program Manager sends it unchanged.	Quick to set up when you already have an API gateway expecting bearer tokens.
Basic Auth	Program Manager Base64-encodes `username:password` → `Authorization: Basic …`.	Simple servers or tools that still rely on HTTP Basic.
None	No `Authorization` header is sent.	Public endpoints (dev / test) or IP-allow-listed servers.

Payload Formats

Program Manager can serialise every callback in two interchangeable formats:

JSON
\n
XML
\n

Specify the desired format per endpoint via the UI or support ticket.

Timeouts and Retries

In the case of a 4xx error, the callback will be marked as failed.

In the case of a 5xx error, we will try to repost up to five (5) times. There will be a 60-second timeout between each attempt. If the callback does notsuccessfully post after the fifth try, it will be marked as failed.

Failed callbacks can be retrieved using the Callback Report API

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"ae05737e-481a-4e41-ba93-220da1f070da","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3445ca20-2164-498a-aca7-4b604da7b9e7","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"7b222963-88b2-4f9d-8fad-f95bdcf6af23"},{"name":"Audience API","item":[{"name":"Audience API - JSON","item":[{"name":"GET Member Information","id":"736a7a66-f83d-4bb9-b0a1-1e99e86978fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"GET","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Api-Version","value":"2.0","type":"text"}],"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?clientmemberid={{client_member_id}}","description":"

Retrieve member information by identifier. Will return entire member record if found.

Searches are exact match. If searching for a dependent, you must use memberid.

Append as query string to API request, i.e. ?mobilephone=13105551212

Using X-Ms-Async-cb will return a report id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Value	Format
`memberid`	mPulse audience member id
`mobilephone`	Phone number	XXXXXXXXXXX (11-digit number), XXXXXXXXXX (10-digit number), XXX-XXX-XXXX, 1-XXX-XXX-XXXX
`email`	Valid email address	N/A
`clientmemberid`	client member id	N/A
`appmemberid`	app member id	N/A

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[{"description":{"content":"

Can use a variety of identifiers. In this case we are using client_member_id.

\n","type":"text/plain"},"key":"clientmemberid","value":"{{client_member_id}}"}],"variable":[]}},"response":[{"id":"05a24689-3bf3-4471-85bc-e53595480d66","name":"GET Member Information - Success","originalRequest":{"method":"GET","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"User-Agent","value":""},{"key":"X-Ms-Async-cb","value":"true","description":"This is an optional header. The header should be enabled only when querying for audience members greater than 35K. This header is used in conjunction with X-Ms-Audience-Get","type":"default","disabled":true},{"key":"X-Ms-Audience-Get","value":"audience","type":"default","disabled":true}],"url":{"raw":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?clientmemberid={{client_member_id}}","protocol":"https","host":["ms-api","mpulsemobile","com"],"path":["accounts","{{account_id}}","members"],"query":[{"key":"clientmemberid","value":"{{client_member_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Jun 2024 18:19:21 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"653"},{"key":"Connection","value":"keep-alive"},{"key":"Etag","value":"\"bbcf6b5d7531539eb39d2890c1bc0ee4a40e10fb\""},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 1,\n \"failure\": 0\n },\n \"members\": [\n {\n \"member\": {\n \"id\": \"120842548\",\n \"result\": \"success\",\n \"profile\": {\n \"RMENABLED\": false,\n \"PREFERREDLANGUAGE\": \"Spanish\",\n \"CITY\": \"Anaheim\",\n \"CLIENTMEMBERID\": \"629941357\",\n \"ADDRESS1\": \"123 Fake Street\",\n \"LASTNAME\": \"Member\",\n \"COUNTRY\": \"United States\",\n \"EMAIL\": \"fakeemail@email.com\",\n \"DATEADDED\": \"2024-02-01\",\n \"BIRTHDATE\": \"1988-01-13\",\n \"FAVORITE_COLOR\": \"Blue\",\n \"SEGMENT_5\": \"Segment Criteria\",\n \"TESTFIELD\": \"Example Single Line\",\n \"PHARM\": \"Pharmacy Name\",\n \"GSD_TEST\": \"TRUE\",\n \"BPD_TEST\": \"TRUE\",\n \"STATE\": \"California\",\n \"FIRSTNAME\": \"Sample\",\n \"ZIP\": \"92805\",\n \"MOBILEPHONE\": \"19095550123\"\n }\n }\n }\n ]\n }\n}"},{"id":"42c01fba-9644-477e-a614-35af838a7f50","name":"GET Member Information - Fail","originalRequest":{"method":"GET","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"User-Agent","value":"","disabled":true},{"key":"X-Ms-Async-cb","value":"true","description":"This is an optional header. The header should be enabled only when querying for audience members greater than 35K. This header is used in conjunction with X-Ms-Audience-Get","type":"default","disabled":true},{"key":"X-Ms-Audience-Get","value":"audience","type":"default","disabled":true}],"url":{"raw":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?clientmemberid=","protocol":"https","host":["ms-api","mpulsemobile","com"],"path":["accounts","{{account_id}}","members"],"query":[{"key":"clientmemberid","value":"","description":"Can use a variety of identifiers. In this case we are using client_member_id."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Jun 2024 19:15:46 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"168"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 0,\n \"failure\": 1\n },\n \"errors\": {\n \"json_error\": {\n \"code\": \"MS-ERR-251\",\n \"message\": \"Member with clientmemberid: not found\",\n \"detail\": {}\n }\n }\n }\n}"}],"_postman_id":"736a7a66-f83d-4bb9-b0a1-1e99e86978fa"},{"name":"GET Member Subscription Statuses","id":"50fa2d86-2258-4a56-8135-8b29df225cfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"GET","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Get","value":"subscriptions"},{"key":"X-Ms-Api-Version","value":"2.1","description":"

Allowed Values: 1.1 and 2.1. Version 2.1 has updates to standardize JSON responses. Please note using the version 2.1 will require updates on the API clients to handle the change in the JSON response structure.

\n","type":"default"}],"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?q={{client_member_id}}","description":"

Retrieves member subscription statuses
\nCan look up by query {q}; append to end of URL as query parameter.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Find By	{q}
Client Member ID	`<body><member><clientmemberid>{CLIENT_MEMBER_ID}</clientmemberid></member></body>`
Mobile Phone Number	`<body><member><mobilephone>{MOBILE_PHONE_NUMBER}</mobilephone></member></body>`
Email Address	`<body><member><email>{EMAIL_ADDRESS}</email></member></body>`
App Member ID	`<body><member><appmemberid>{APP_MEMBER_ID}</appmemberid></member></body>`

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[{"key":"q","value":"{{client_member_id}}"},{"disabled":true,"key":"mobilephone","value":"{{mobile_phone}}"}],"variable":[]}},"response":[{"id":"3108316e-1cc7-407b-8b57-9be9d5ccbbec","name":"GET Member Subscription Statuses - Success","originalRequest":{"method":"GET","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Get","value":"subscriptions"},{"key":"X-Ms-Api-Version","value":"2.1","description":"Allowed Values: 1.1 and 2.1. Version 2.1 has updates to standardize JSON responses. Please note using the version 2.1 will require updates on the API clients to handle the change in the JSON response structure.","type":"default"}],"url":{"raw":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?q={{client_member_id}}","protocol":"https","host":["ms-api","mpulsemobile","com"],"path":["accounts","{{account_id}}","members"],"query":[{"key":"q","value":"{{client_member_id}}"},{"key":"mobilephone","value":"{{mobile_phone}}","type":"text","disabled":true}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Jun 2024 21:26:44 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"476"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 1,\n \"failure\": 0\n },\n \"members\": [\n {\n \"member\": {\n \"list\": [\n {\n \"listid\": \"11023\",\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"INACTIVE\",\n \"on_gprl\": \"false\"\n }\n }\n },\n {\n \"listid\": \"16159\",\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"ACTIVE\",\n \"on_gprl\": \"false\"\n },\n \"email\": {\n \"status\": \"PENDING\"\n },\n \"ivr\": {\n \"status\": \"INACTIVE\"\n }\n }\n }\n ],\n \"id\": {\n \"memberid\": \"120842548\",\n \"email\": \"fakeemail@email.com\",\n \"mobilephone\": \"19096143073\",\n \"clientmemberid\": \"629941357\"\n }\n }\n }\n ],\n \"errors\": null\n }\n}"},{"id":"c3c5850a-b623-4457-98b9-676dfabf5cd7","name":"GET Member Subscription Statuses - Failure","originalRequest":{"method":"GET","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Get","value":"subscriptions"},{"key":"X-Ms-Api-Version","value":"2.1","description":"Allowed Values: 1.1 and 2.1. Version 2.1 has updates to standardize JSON responses. Please note using the version 2.1 will require updates on the API clients to handle the change in the JSON response structure.","type":"default"}],"url":{"raw":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?q={{client_member_id}}","protocol":"https","host":["ms-api","mpulsemobile","com"],"path":["accounts","{{account_id}}","members"],"query":[{"key":"q","value":"{{client_member_id}}"},{"key":"mobilephone","value":"{{mobile_phone}}","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Jun 2024 21:28:41 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"285"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 0,\n \"failure\": 1\n },\n \"members\": [\n {\n \"member\": {\n \"member_errors\": {\n \"member_error\": {\n \"code\": \"MS-ERR-003\",\n \"message\": \"Invalid parameter value\",\n \"detail\": {\n \"parameter\": \"clientmemberid\",\n \"value\": \"629941357adsasd\",\n \"reason\": \"no_member\"\n }\n }\n }\n }\n }\n ],\n \"errors\": null\n }\n}"}],"_postman_id":"50fa2d86-2258-4a56-8135-8b29df225cfc"},{"name":"Get Report API","id":"af03e44d-e5b1-4090-8848-48d2eca80016","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"","username":""},"isInherited":false},"method":"GET","header":[{"key":"X-Ms-Source","value":"api","type":"default"}],"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members/file/{{file_request_id}}","description":"

The endpoint generates a audience member report based on the file request id.

The file request id is generated by running the Get Member Information with X-Ms-Async-cb set to true.

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members","file","{{file_request_id}}"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"af03e44d-e5b1-4090-8848-48d2eca80016"},{"name":"Create Member","event":[{"listen":"test","script":{"id":"ff3c91c0-90c6-4d8d-821d-eabe85a6c8c2","exec":["let jsonData = JSON.parse(responseBody);","","pm.environment.set(\"member_id\", jsonData.body.members[0].member.id.memberid);"],"type":"text/javascript","packages":{}}}],"id":"a583ae89-89d6-486e-9211-9b9924e885e1","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n\t\t\"member\": { \n\t\t\t\"firstname\": \"Kevin\",\n\t\t\t\"lastname\": \"McGrath\",\n\t\t\t\"zipcode\":\"90210\",\n\t\t\t\"email\": \"kevin.mcgrath@yopmail.com\",\n\t\t\t\"mobilephone\": \"18186893185\",\n\t\t\t\"clientmemberid\": \"PP-33883821c\",\n\t\t\t\"appmemberid\": \"app238383828\"\n\t }\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Create a member.

In order to add a member to the mPulse system, the member must have at least one valid contact method/identifier. The identifier must be unique to the account (unless your account is enabled for the Shared Contact feature.)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

Sample Success Response:

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"kevin.mcgrath@yopmail.com\",\n                        \"mobilephone\": \"18186893185\",\n                        \"appmemberid\": \"app238383828\",\n                        \"memberid\": 86795317,\n                        \"clientmemberid\": \"PP-33883821c\"\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"EMAIL\": \"kevin.mcgrath@yopmail.com\",\n                        \"DATEADDED\": \"2025-09-03 06:10 PDT\",\n                        \"RMENABLED\": false,\n                        \"ZIP\": \"90210\",\n                        \"MOBILEPHONE\": \"18186893185\",\n                        \"LASTNAME\": \"McGrath\",\n                        \"APPMEMBERID\": \"app238383828\",\n                        \"CLIENTMEMBERID\": \"PP-33883821c\",\n                        \"TESTMEMBER\": false,\n                        \"FIRSTNAME\": \"Kevin\"\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Errors due to wrong payload will result in a failure to add the member. Some sample error responses are provided below:

A member with the provided email already exists:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"nakul.sharma@emids.com\",\n                        \"mobilephone\": \"18186793181\",\n                        \"appmemberid\": \"app238383822\"\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": \"IDENTIFIERS\",\n                                    \"value\": \"email: nakul.sharma@emids.com, sms: 18186793181, app_member_id: app238383822, clientmemberid: PP-33883821x\",\n                                    \"reason\": \"not_unique\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

Mobile phone is invalid:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"garmin.forerunner@emids.com\",\n                        \"appmemberid\": \"app238383822\"\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": \"MOBILEPHONE\",\n                                    \"value\": \"6789042\",\n                                    \"reason\": \"invalid_format\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

No Identifier provided:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-001\",\n                                \"message\": \"A required field is missing\",\n                                \"detail\": {\n                                    \"parameter\": [\n                                        \"mobilephone\",\n                                        \"email\",\n                                        \"appmemberid\"\n                                    ]\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a583ae89-89d6-486e-9211-9b9924e885e1"},{"name":"Create Member & Subscribe","event":[{"listen":"test","script":{"id":"cffa5925-f8d3-41a2-b821-033e1289b946","exec":["let jsonData = JSON.parse(responseBody);","","pm.environment.set(\"member_id\", jsonData.body.members[0].member.id.memberid);","var template = `","","",""," "," "," "," "," "," "," "," "," "," "," "," "," {{#each response.body.members}}"," "," "," "," "," "," "," "," "," "," "," "," {{/each}}","

Email	Member ID	Result	Error Code	Error Message	Parameter	Value	Reason	Status
{{member.id.email}}	{{member.id.memberid}}	{{member.result}}	{{member.member_errors.[0].member_error.code}}	{{member.member_errors.[0].member_error.message}}	{{member.member_errors.[0].member_error.detail.parameter}}	{{member.member_errors.[0].member_error.detail.value}}	{{member.member_errors.[0].member_error.detail.reason}}	{{member.subscriptions.email.status}}

","`;","","function constructVisualizerPayload() {"," return { response: pm.response.json() }","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"ceb0ded9-8454-4596-84af-168c4954aaf5","exec":[""],"type":"text/javascript","packages":{}}}],"id":"fdad5cdd-e4bb-470a-a35f-0c073f508ff3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n\t \"firstname\": \"Peter\",\n\t \"lastname\": \"Patient\",\n\t \"zipcode\":\"92805\",\n\t \"clientmemberid\": \"PP-33883823x\",\n \"email\" : \"peterpatient@email.com\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}\n\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Create a single member & subscribe to a list for the channels indicated.

The list given in listid must exist; it must have the channel(s) enabled; and the user must have a valid identifier/contact method for that channel in order to be subscribed. For example, the list must have SMS enabled and the user must have a valid phone number to be susbcribed for SMS.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

Sample Success Response:

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"garmin.forerunner@emids.com\",\n                        \"memberid\": 86795316\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"EMAIL\": \"garmin.forerunner@emids.com\",\n                        \"DATEADDED\": \"2025-09-03 06:06 PDT\",\n                        \"RMENABLED\": false,\n                        \"ZIP\": \"90210\",\n                        \"LASTNAME\": \"Forerunner\",\n                        \"TESTMEMBER\": false,\n                        \"FIRSTNAME\": \"Garmin\"\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Errors due to wrong payload will result in a failure to add the member. Some sample error responses are provided below:

Invalid listid:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"errors\": {\n            \"json_error\": {\n                \"code\": \"MS-ERR-003\",\n                \"message\": \"Invalid parameter value\",\n                \"detail\": {\n                    \"parameter\": \"listid\",\n                    \"value\": \"7892344\",\n                    \"reason\": \"no_list\"\n                }\n            }\n        }\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[{"id":"e54b1d21-42b4-48e1-9785-b1ab408d2748","name":"Create Member & Subscribe - Success","originalRequest":{"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n\t \"firstname\": \"Peter\",\n\t \"lastname\": \"Patient\",\n\t \"zipcode\":\"90210\",\n\t \"clientmemberid\": \"PP-33883823x\",\n \"email\" : \"peterpatient@email.com\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}\n\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:23:42 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"449"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 1,\n \"failure\": 0\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"email\": \"peterpatient@email.com\",\n \"memberid\": 129440937,\n \"clientmemberid\": \"PP-33883823x\"\n },\n \"result\": \"success\",\n \"profile\": {\n \"FIRSTNAME\": \"Peter\",\n \"LASTNAME\": \"Patient\",\n \"RMENABLED\": false,\n \"CLIENTMEMBERID\": \"PP-33883823x\",\n \"DATEADDED\": \"2024-06-24 20:23 PDT\",\n \"ZIP\": \"90210\",\n \"EMAIL\": \"peterpatient@email.com\"\n },\n \"subscriptions\": {\n \"email\": {\n \"status\": \"ACTIVE\"\n }\n }\n }\n }\n ]\n }\n}"},{"id":"7f64ad01-1ac8-4029-8c1a-e994df783684","name":"Create Member & Subscribe - Failure","originalRequest":{"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n\t \"firstname\": \"Polly\",\n\t \"lastname\": \"Patient\",\n\t \"zipcode\":\"90210\",\n\t \"mobilephone\": \"13105551212\",\n\t \"clientmemberid\": \"PP-33883821x\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}\n\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:20:43 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"491"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 0,\n \"failure\": 1\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"email\": \"polly.patient@hotmail.com\",\n \"mobilephone\": \"13105551212\",\n \"appmemberid\": \"app238383822\"\n },\n \"result\": \"failure\",\n \"member_errors\": [\n {\n \"member_error\": {\n \"code\": \"MS-ERR-003\",\n \"message\": \"Invalid parameter value\",\n \"detail\": {\n \"parameter\": \"IDENTIFIERS\",\n \"value\": \"email: polly.patient@hotmail.com, sms: 13105551212, app_member_id: app238383822, clientmemberid: PP-33883821x\",\n \"reason\": \"not_unique\"\n }\n }\n }\n ]\n }\n }\n ]\n }\n}"},{"id":"c38d1a69-e657-49cf-921d-286bab298e00","name":"Create Member & Subscribe - Bad Number","originalRequest":{"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n\t \"firstname\": \"Peter\",\n\t \"lastname\": \"Patient\",\n\t \"zipcode\":\"90210\",\n\t \"mobilephone\": \"19095550413\",\n\t \"clientmemberid\": \"PP-33883822x\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}\n\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:22:41 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"333"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 0,\n \"failure\": 1\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"mobilephone\": \"19095550413\"\n },\n \"result\": \"failure\",\n \"member_errors\": [\n {\n \"member_error\": {\n \"code\": \"MS-ERR-003\",\n \"message\": \"Invalid parameter value\",\n \"detail\": {\n \"parameter\": \"MOBILEPHONE\",\n \"value\": \"19095550413\",\n \"reason\": \"UNSUPPORTED_CARRIER\"\n }\n }\n }\n ]\n }\n }\n ]\n }\n}"}],"_postman_id":"fdad5cdd-e4bb-470a-a35f-0c073f508ff3"},{"name":"Create Multiple Members & Subscribe","event":[{"listen":"test","script":{"id":"cffa5925-f8d3-41a2-b821-033e1289b946","exec":["let jsonData = JSON.parse(responseBody);","","pm.environment.set(\"member_id\", jsonData.body.members[0].member.id.memberid);"],"type":"text/javascript"}}],"id":"ef94c4c2-3719-4604-b1a0-5943adbe60b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": [\n \t\t{ \n\t\t \"firstname\": \"Polly\",\n\t\t \"lastname\": \"Patient\",\n\t\t \"zipcode\":\"90210\",\n\t\t \"email\": \"polly.patient@hotmail.com\",\n\t\t \"mobilephone\": \"18186793181\",\n\t\t \"clientmemberid\": \"PP-33883821xxxx\",\n\t\t \"appmemberid\": \"app2xxx38383822\"\n\t \t},\n\t \t{\n\t \t\t\"firstname\": \"Mikey\",\n\t \t\t\"lastname\": \"Member\",\n\t \t\t\"zipcode\": 91604,\n\t \t\t\"mobilephone\": \"13105551313\"\n\t \t}\n\t ],\n \t\"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Create and subscribe multiple members to a list for the channels indicated.

The list given in listid must exist; it must have the channel(s) enabled; and the user must have a valid identifier/contact method for that channel in order to be subcribed. For example, the list must have SMS enabled and the user must have a valid phone number to be susbcribed for SMS.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

Sample request with success response:

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 2,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"robbie.member2@yopmail.com\",\n                        \"mobilephone\": \"18186794582\",\n                        \"appmemberid\": \"app2xxx38383823\",\n                        \"memberid\": 86795319,\n                        \"clientmemberid\": \"PP-33883821xxxy\"\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"EMAIL\": \"robbie.member2@yopmail.com\",\n                        \"DATEADDED\": \"2025-09-03 06:16 PDT\",\n                        \"RMENABLED\": false,\n                        \"ZIP\": \"90210\",\n                        \"MOBILEPHONE\": \"18186794582\",\n                        \"LASTNAME\": \"Member\",\n                        \"APPMEMBERID\": \"app2xxx38383823\",\n                        \"CLIENTMEMBERID\": \"PP-33883821xxxy\",\n                        \"TESTMEMBER\": false,\n                        \"FIRSTNAME\": \"Robbie\"\n                    },\n                    \"subscriptions\": {\n                        \"email\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"sms\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"appmemberid\": {\n                            \"status\": \"SUBSCRIBED\"\n                        }\n                    }\n                }\n            },\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"13105551414\",\n                        \"memberid\": 86795320\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"DATEADDED\": \"2025-09-03 06:16 PDT\",\n                        \"MOBILEPHONE\": \"13105551414\",\n                        \"RMENABLED\": false,\n                        \"ZIP\": \"91604\",\n                        \"LASTNAME\": \"Member\",\n                        \"TESTMEMBER\": false,\n                        \"FIRSTNAME\": \"Mikey\"\n                    },\n                    \"subscriptions\": {\n                        \"ivr\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"sms\": {\n                            \"status\": \"ACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Sample Request with partial success:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"robbie.member@yopmail.com\",\n                        \"mobilephone\": \"18186794581\",\n                        \"appmemberid\": \"app2xxx38383822\",\n                        \"memberid\": 86795318,\n                        \"clientmemberid\": \"PP-33883821xxxx\"\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"EMAIL\": \"robbie.member@yopmail.com\",\n                        \"DATEADDED\": \"2025-09-03 06:14 PDT\",\n                        \"RMENABLED\": false,\n                        \"ZIP\": \"90210\",\n                        \"MOBILEPHONE\": \"18186794581\",\n                        \"LASTNAME\": \"Member\",\n                        \"APPMEMBERID\": \"app2xxx38383822\",\n                        \"CLIENTMEMBERID\": \"PP-33883821xxxx\",\n                        \"TESTMEMBER\": false,\n                        \"FIRSTNAME\": \"Robbie\"\n                    },\n                    \"subscriptions\": {\n                        \"email\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"sms\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"appmemberid\": {\n                            \"status\": \"SUBSCRIBED\"\n                        }\n                    }\n                }\n            },\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"13105551313\",\n                        \"memberid\": 84344406\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": \"mobile_phone\",\n                                    \"value\": \"13105551313\",\n                                    \"reason\": \"not_unique\"\n                                }\n                            }\n                        },\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": \"mobilephone\",\n                                    \"value\": \"13105551313\",\n                                    \"reason\": \"not_unique\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef94c4c2-3719-4604-b1a0-5943adbe60b8"},{"name":"Create & Subscribe New Member; Subscribe Existing Member","event":[{"listen":"test","script":{"id":"72a77a7d-bd7e-429d-a7ac-03dc64f16071","type":"text/javascript","exec":["let jsonData = JSON.parse(responseBody);","","pm.environment.set(\"member_id\", jsonData.body.members[0].member.id.memberid);"]}}],"id":"9bdc72ad-2d38-4ec8-9e30-fec766a5a584","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n\t \"firstname\": \"Polly\",\n\t \"lastname\": \"Patient\",\n\t \"zipcode\":\"90210\",\n\t \"email\": \"polly.patient@hotmail.com\",\n\t \"mobilephone\": \"13105551212\",\n\t \"clientmemberid\": \"PP-33883821x\",\n\t \"appmemberid\": \"app238383822\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Create a single member & subscribe to a list for channels listed; subscribe an existing member to a list for the channels listed.

The header X-Ms-Ignore-Error-For-Existing-Members must be true for this to work.

The list given in listid must exist; it must have the channel(s) enabled; and the user must have a valid identifier for that channel in order to be subcribed. For example, the list must have SMS enabled and the user must have a valid phone number to be susbcribed for SMS.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9bdc72ad-2d38-4ec8-9e30-fec766a5a584"},{"name":"Create & Subscribe New Member; Subscribe or Resubscribe Existing Member","event":[{"listen":"test","script":{"id":"7b9a1339-3520-4fae-9794-b7b7a7f543a4","type":"text/javascript","exec":["let jsonData = JSON.parse(responseBody);","","pm.environment.set(\"member_id\", jsonData.body.members[0].member.id.memberid);"]}}],"id":"3ba6c43d-492e-4646-bd63-6991ef0efead","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true"},{"key":"X-Ms-Force-Subscribe-Member","value":"true"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n\t \"firstname\": \"Polly\",\n\t \"lastname\": \"Patient\",\n\t \"zipcode\":\"90210\",\n\t \"email\": \"polly.patient@hotmail.com\",\n\t \"mobilephone\": \"13105551212\",\n\t \"clientmemberid\": \"PP-33883821x\",\n\t \"appmemberid\": \"app238383822\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Create a single member & subscribe to a list for the channels listed; subscribe or resubscribe an existing member.

The headers X-Ms-Ignore-Error-For-Existing-Members and X-Ms-Force-Subscribe-Member should be provided.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ba6c43d-492e-4646-bd63-6991ef0efead"},{"name":"Update Member (All Fields)","event":[{"listen":"test","script":{"id":"6a7c4e23-32e0-4724-bb8f-105fd6a1d675","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c24adf84-8f31-425f-b2c4-5dfdd864dd2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"body\": {\n \"member\": \n { \n \"clientmemberid\" : {{client_member_id}},\n \"firstname\": \"Change Firstame\",\n \"lastname\": \"Change Lastname\"\n }\n }\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Will update member

Warning: This will overwrite all member profile fields given as parameters and null out any non-included fields (except audience member ID).

Must find member by mobilephone, email, or appmember ID.

Sample success response:

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"nakul.sharma@emids.com\"\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"EMAIL\": \"nakul.sharma@emids.com\",\n                        \"DATEADDED\": \"2025-09-01 00:36 PDT\",\n                        \"RMENABLED\": false,\n                        \"LASTNAME\": \"Change Lastname\",\n                        \"TESTMEMBER\": false,\n                        \"FIRSTNAME\": \"Change Firstame\",\n                        \"MEMBERID\": 86793779\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Sample Error Responses:

Member not found with identifier given in request:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"bahee.notfound@mpulse.com\"\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-001\",\n                                \"message\": \"A required field is missing\",\n                                \"detail\": {\n                                    \"reason\": \"no_member\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

Two Identifiers belonging to different members:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"kevin.mcgrath@yopmail.com\",\n                        \"mobilephone\": \"13105551414\"\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": \"email\",\n                                    \"value\": \"kevin.mcgrath@yopmail.com\",\n                                    \"reason\": \"not_unique\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

If included and set to included_fields_only only update the fields in the provided request

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n\t\t\"member\": { \n\t \"client_member_id\" : {{client_member_id}},\n \"mobilephone\" : {{mobile_phone}},\n\t \"firstname\": \"Fname Change\",\n\t \"lastname\": \"Lname Change\",\n \"favorite_color\" : \"blue\"\n \t}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Update member

Will only update fields included in the request. Will not nullify fields not included in the request. The header X-Ms-Update should be set to 'included_fields_only'

Can update by memberid, mobilephone, email, clientmemberid, appmemberid

Sample success response:

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"kevin.mcgrath@yopmail.com\"\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"EMAIL\": \"kevin.mcgrath@yopmail.com\",\n                        \"DATEADDED\": \"2025-09-03 06:10 PDT\",\n                        \"MOBILEPHONE\": \"18186893185\",\n                        \"ZIP\": \"90210\",\n                        \"RMENABLED\": false,\n                        \"LASTNAME\": \"McGrath new last name\",\n                        \"APPMEMBERID\": \"app238383828\",\n                        \"CLIENTMEMBERID\": \"PP-33883821c\",\n                        \"TESTMEMBER\": false,\n                        \"FIRSTNAME\": \"Kevin new first name\",\n                        \"MEMBERID\": 86795317\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Description:

Update member; only updates fields that are null or different than proposed value.

Can look up member by one of:

email, mobile_phone, app_member_id, client_member_id

Sample success response (only last name and email provided in request):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"kevin.mcgrath@yopmail.com\"\n                    },\n                    \"result\": \"success\",\n                    \"profile\": {\n                        \"EMAIL\": \"kevin.mcgrath@yopmail.com\",\n                        \"DATEADDED\": \"2025-09-03 06:10 PDT\",\n                        \"RMENABLED\": false,\n                        \"LASTNAME\": \"McGrath\",\n                        \"TESTMEMBER\": false,\n                        \"MEMBERID\": 86795317\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Description:

Creates & Subscribes a new Member
\n
Updates and Subscribes an existing Member
\n
Updates and Re-Subscribes an existing Member
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"434f9d68-aca2-492e-9b81-21b95768d6b7"},{"name":"Resubscribe Member","event":[{"listen":"test","script":{"id":"dc2cddcc-838a-4941-947b-aa0ec41721b1","exec":["tests[\"Status code is success\"] = responseCode.code >= 200 && responseCode.code < 300;"],"type":"text/javascript","packages":{}}}],"id":"77581388-b4f2-41f1-9921-1ee27643a030","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Audience-Update","value":"resub","description":"

Used for PUT endpoint to determine what actions should be taken on Member update. update, upsert, delta, sub, unsub, or resub

\n"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"{{mobile_phone}}\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Updates a Member's subscription status from \"Unsubscribed\" to \"Subscribed\"

The header X-Ms-Audience-Update should have a value of resub

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

Sample success response:

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"18186794582\",\n                        \"memberid\": 86795319\n                    },\n                    \"result\": \"success\",\n                    \"subscriptions\": {\n                        \"sms\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"ACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Sample error response (member is already subscribed):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"18186794582\",\n                        \"memberid\": 86795319\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-125\",\n                                \"message\": \"Cannot resubscribe member to the ivr channel of the list\",\n                                \"detail\": {\n                                    \"parameter\": \"ivr\",\n                                    \"value\": \"18186794582\",\n                                    \"reason\": \"already_subscribed\"\n                                }\n                            }\n                        },\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-124\",\n                                \"message\": \"Cannot resubscribe member to the sms channel of the list\",\n                                \"detail\": {\n                                    \"parameter\": \"mobilephone\",\n                                    \"value\": \"18186794582\",\n                                    \"reason\": \"already_subscribed\"\n                                }\n                            }\n                        }\n                    ],\n                    \"subscriptions\": {\n                        \"sms\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"ACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[{"id":"7ddac405-852e-41c1-8612-736359494e62","name":"Resubscribe Member - Success","originalRequest":{"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Audience-Update","value":"resub","description":"Used for PUT endpoint to determine what actions should be taken on Member update. update, upsert, delta, sub, unsub, or resub"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"{{mobile_phone}}\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:57:55 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 1,\n \"failure\": 0\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"mobilephone\": \"19095553073\",\n \"memberid\": 120842548\n },\n \"result\": \"success\",\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"ACTIVE\"\n },\n \"ivr\": {\n \"status\": \"ACTIVE\"\n }\n }\n }\n }\n ]\n }\n}"},{"id":"af0a96e3-0792-4f00-9f18-2faadf9a6ef8","name":"Resubscribe Member - Fail","originalRequest":{"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Audience-Update","value":"resub","description":"Used for PUT endpoint to determine what actions should be taken on Member update. update, upsert, delta, sub, unsub, or resub"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"{{mobile_phone}}\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:56:49 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"666"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 0,\n \"failure\": 1\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"mobilephone\": \"19095553073\",\n \"memberid\": 120842548\n },\n \"result\": \"failure\",\n \"member_errors\": [\n {\n \"member_error\": {\n \"code\": \"MS-ERR-125\",\n \"message\": \"Cannot resubscribe member to the ivr channel of the list\",\n \"detail\": {\n \"parameter\": \"ivr\",\n \"value\": \"19096143073\",\n \"reason\": \"already_subscribed\"\n }\n }\n },\n {\n \"member_error\": {\n \"code\": \"MS-ERR-124\",\n \"message\": \"Cannot resubscribe member to the sms channel of the list\",\n \"detail\": {\n \"parameter\": \"mobilephone\",\n \"value\": \"19096143073\",\n \"reason\": \"already_subscribed\"\n }\n }\n }\n ],\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"ACTIVE\"\n },\n \"ivr\": {\n \"status\": \"ACTIVE\"\n }\n }\n }\n }\n ]\n }\n}"}],"_postman_id":"77581388-b4f2-41f1-9921-1ee27643a030"},{"name":"Unsubscribe Member","event":[{"listen":"test","script":{"id":"dc2cddcc-838a-4941-947b-aa0ec41721b1","exec":["tests[\"Status code is success\"] = responseCode.code >= 200 && responseCode.code < 300;"],"type":"text/javascript"}}],"id":"812e1647-39b8-4c34-b121-7fcb6e790c09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Update","value":"unsub"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"13105551212\"\n \t},\n \"listid\": {{list_id}}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Unsubscribes a Member from one or more channels on a specific list. One list per request.

The X-Ms-Audience-Update header must have a value of unsub

The list given in listid must exist; it must have the channel(s) enabled; the user must have a valid identifier for that channel, and the user must currently be subscribed to that channel in order to be unsubcribed. For example, the list must have SMS enabled and the user must have a valid phone number and already be subscribed to be unsusbcribed for SMS.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

Sample success response:

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"18186794582\",\n                        \"memberid\": 86795319\n                    },\n                    \"result\": \"success\",\n                    \"subscriptions\": {\n                        \"sms\": {\n                            \"status\": \"INACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"INACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Sample Error Response (member is already unsubscribed):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"18186794582\",\n                        \"memberid\": 86795319\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-130\",\n                                \"message\": \"Cannot unsubscribe member from the ivr channel of the list\",\n                                \"detail\": {\n                                    \"parameter\": \"ivr\",\n                                    \"value\": \"18186794582\",\n                                    \"reason\": \"subscription_not_active\"\n                                }\n                            }\n                        },\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-129\",\n                                \"message\": \"Cannot unsubscribe member from the sms channel of the list\",\n                                \"detail\": {\n                                    \"parameter\": \"mobilephone\",\n                                    \"value\": \"18186794582\",\n                                    \"reason\": \"subscription_not_active\"\n                                }\n                            }\n                        }\n                    ],\n                    \"subscriptions\": {\n                        \"sms\": {\n                            \"status\": \"INACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"INACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[{"id":"c7193ae3-8374-4735-ab66-0de21ec089ba","name":"Unsubscribe Member - Success","originalRequest":{"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Update","value":"unsub","description":"Used for PUT endpoint to determine what actions should be taken on Member update. update, upsert, delta, sub, unsub, or resub"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"{{mobile_phone}}\"\n \t},\n \"listid\": {{list_id}}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:57:17 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"241"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 1,\n \"failure\": 0\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"mobilephone\": \"19095553073\",\n \"memberid\": 120842548\n },\n \"result\": \"success\",\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"INACTIVE\"\n },\n \"ivr\": {\n \"status\": \"INACTIVE\"\n }\n }\n }\n }\n ]\n }\n}"},{"id":"dfb70278-316a-4d24-9fa6-90d143d26298","name":"Unsubscribe Member - Fail","originalRequest":{"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Update","value":"unsub","description":"Used for PUT endpoint to determine what actions should be taken on Member update. update, upsert, delta, sub, unsub, or resub"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"{{mobile_phone}}\"\n \t},\n \"listid\": {{list_id}}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:57:39 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"684"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 0,\n \"failure\": 1\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"mobilephone\": \"19095553073\",\n \"memberid\": 120842548\n },\n \"result\": \"failure\",\n \"member_errors\": [\n {\n \"member_error\": {\n \"code\": \"MS-ERR-130\",\n \"message\": \"Cannot unsubscribe member from the ivr channel of the list\",\n \"detail\": {\n \"parameter\": \"ivr\",\n \"value\": \"19096143073\",\n \"reason\": \"subscription_not_active\"\n }\n }\n },\n {\n \"member_error\": {\n \"code\": \"MS-ERR-129\",\n \"message\": \"Cannot unsubscribe member from the sms channel of the list\",\n \"detail\": {\n \"parameter\": \"mobilephone\",\n \"value\": \"19096143073\",\n \"reason\": \"subscription_not_active\"\n }\n }\n }\n ],\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"INACTIVE\"\n },\n \"ivr\": {\n \"status\": \"INACTIVE\"\n }\n }\n }\n }\n ]\n }\n}"}],"_postman_id":"812e1647-39b8-4c34-b121-7fcb6e790c09"},{"name":"Subscribe Member","event":[{"listen":"test","script":{"id":"dc2cddcc-838a-4941-947b-aa0ec41721b1","exec":["tests[\"Status code is success\"] = responseCode.code >= 200 && responseCode.code < 300;"],"type":"text/javascript"}}],"id":"4f1bd582-32c8-472f-8b8c-dc0f3096176b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true"},{"key":"X-Ms-Update","value":"included_fields_only"},{"key":"X-Ms-Audience-Update","value":"sub","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"18186793181\"\n \t},\n \"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Audience API - subscribe a member to a single list. The member must already exist in the account.

The header X-Ms-Audience-Update should have a value of sub

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push

Sample success response:

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"13105551414\",\n                        \"memberid\": 86795320\n                    },\n                    \"result\": \"success\",\n                    \"subscriptions\": {\n                        \"sms\": {\n                            \"status\": \"ACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"ACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Sample error response(member was unsubscribed previously, instead of sub, use resub in this scenario):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"18186794582\",\n                        \"memberid\": 86795319\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-113\",\n                                \"message\": \"Cannot subscribe member to the sms channel of the list\",\n                                \"detail\": {\n                                    \"parameter\": \"mobilephone\",\n                                    \"value\": \"18186794582\",\n                                    \"reason\": \"unsubscribed_sms\"\n                                }\n                            }\n                        },\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-114\",\n                                \"message\": \"Cannot subscribe member to the ivr channel of the list\",\n                                \"detail\": {\n                                    \"parameter\": \"ivr\",\n                                    \"value\": \"18186794582\",\n                                    \"reason\": \"unsubscribed_ivr\"\n                                }\n                            }\n                        }\n                    ],\n                    \"subscriptions\": {\n                        \"sms\": {\n                            \"status\": \"INACTIVE\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"INACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Sample error response (no member found with given identifier):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"15674323459\"\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": \"mobilephone\",\n                                    \"value\": \"15674323459\",\n                                    \"reason\": \"no_member\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[{"id":"17fca53d-e6ff-487c-a678-5a4c27bf6a8c","name":"Subscribe Member - Success","originalRequest":{"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true","description":"If a Member already exists with the given information, do not fail request."},{"key":"X-Ms-Update","value":"included_fields_only","description":"If included and set to included_fields_only only update the fields provided in the request"},{"key":"X-Ms-Audience-Update","value":"sub","description":"Used for PUT endpoint to determine what actions should be taken on Member update. update, upsert, delta, sub, unsub, or resub","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"{{mobile_phone}}\"\n \t},\n \"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:54:23 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"237"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 1,\n \"failure\": 0\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"mobilephone\": \"19095553073\",\n \"memberid\": 120842548\n },\n \"result\": \"success\",\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"ACTIVE\"\n },\n \"ivr\": {\n \"status\": \"ACTIVE\"\n }\n }\n }\n }\n ]\n }\n}"},{"id":"753f55f1-f67b-4168-9ae9-8b80f2821e21","name":"Subscribe Member - Fail","originalRequest":{"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true","description":"If a Member already exists with the given information, do not fail request."},{"key":"X-Ms-Update","value":"included_fields_only","description":"If included and set to included_fields_only only update the fields provided in the request"},{"key":"X-Ms-Audience-Update","value":"sub","description":"Used for PUT endpoint to determine what actions should be taken on Member update. update, upsert, delta, sub, unsub, or resub","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n \t\"member\": { \n \t\"mobilephone\": \"{{mobile_phone}}\"\n \t},\n \"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Jun 2024 03:54:55 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"662"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"TornadoServer/6.3.3"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"results\": {\n \"success\": 0,\n \"failure\": 1\n },\n \"members\": [\n {\n \"member\": {\n \"id\": {\n \"mobilephone\": \"19096143073\",\n \"memberid\": 120842548\n },\n \"result\": \"failure\",\n \"member_errors\": [\n {\n \"member_error\": {\n \"code\": \"MS-ERR-113\",\n \"message\": \"Cannot subscribe member to the sms channel of the list\",\n \"detail\": {\n \"parameter\": \"mobilephone\",\n \"value\": \"19096143073\",\n \"reason\": \"already_subscribed\"\n }\n }\n },\n {\n \"member_error\": {\n \"code\": \"MS-ERR-114\",\n \"message\": \"Cannot subscribe member to the ivr channel of the list\",\n \"detail\": {\n \"parameter\": \"ivr\",\n \"value\": \"19096143073\",\n \"reason\": \"already_subscribed\"\n }\n }\n }\n ],\n \"subscriptions\": {\n \"sms\": {\n \"status\": \"ACTIVE\"\n },\n \"ivr\": {\n \"status\": \"ACTIVE\"\n }\n }\n }\n }\n ]\n }\n}"}],"_postman_id":"4f1bd582-32c8-472f-8b8c-dc0f3096176b"},{"name":"Subscribe Member to List w/ Double-Opt In & Send Welcome Msg","event":[{"listen":"test","script":{"id":"dc2cddcc-838a-4941-947b-aa0ec41721b1","type":"text/javascript","exec":["tests[\"Status code is success\"] = responseCode.code >= 200 && responseCode.code < 300;"]}}],"id":"da268128-bce7-4cd3-86a4-38c74892031c","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true"},{"key":"X-Ms-Update","value":"included_fields_only"},{"key":"X-Ms-List-Confirm","value":"true"},{"key":"Send-Welcome-Message","value":"true"},{"key":"X-Ms-Audience-Update","value":"sub"}],"body":{"mode":"raw","raw":"{\n\t\"body\": {\n\t\t\"member\": { \n \t\t\"memberid\": {{member_id}},\n \t\"email\": \"polly.patient@hotmail.com\"\n \t},\n \t\"listid\": {{list_id}}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Subscribe a member to a list with double-opt in and send welcome message. Member must exist in the account.

The list must have double optin enabled for the respective channel and X-Ms-List-Confirm and Send-Welcome-Message headers must be provided with a value of true.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

Sample success response (request with mobilephone, list had sms with double optin enabled):

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"18133654432\",\n                        \"memberid\": 86795000\n                    },\n                    \"result\": \"success\",\n                    \"subscriptions\": {\n                        \"sms\": {\n                            \"status\": \"PENDING\"\n                        },\n                        \"ivr\": {\n                            \"status\": \"ACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

Sample error response(channel not enabled on list):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"nakul.sharma@emids.com\",\n                        \"memberid\": 86793779\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-106\",\n                                \"message\": \"Cannot subscribe member to the email channel of the list\",\n                                \"detail\": {\n                                    \"parameter\": \"email\",\n                                    \"value\": \"nakul.sharma@emids.com\",\n                                    \"reason\": \"email_channel_not_supported\"\n                                }\n                            }\n                        }\n                    ],\n                    \"subscriptions\": {\n                        \"email\": {\n                            \"status\": \"ACTIVE\"\n                        }\n                    }\n                }\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"da268128-bce7-4cd3-86a4-38c74892031c"},{"name":"Delete Member","event":[{"listen":"test","script":{"id":"dc2cddcc-838a-4941-947b-aa0ec41721b1","type":"text/javascript","exec":["tests[\"Status code is success\"] = responseCode.code >= 200 && responseCode.code < 300;"]}}],"id":"9050c2d0-39ea-44b7-85fb-5fcd527bde45","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-Ms-Format","value":"json"},{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"body\": { \n\t\t\"member\": { \n \t\t\"email\": \"polly.patient@hotmail.com\" \n\t\t}\n\t}\n}"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Description:

Delete a member.

Can delete by memberid, mobilephone, email, appmemberid, clientmemberid

Sample success response:

status code: 200

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"13105551414\",\n                        \"memberid\": 86795320\n                    },\n                    \"result\": \"success\"\n                }\n            }\n        ]\n    }\n}\n\n

Sample error response (member didn't exist):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 0,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"mobilephone\": \"13105551414\"\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": [\n                                        \"mobilephone\"\n                                    ],\n                                    \"reason\": \"Member does not exist\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            }\n        ]\n    }\n}\n\n

Description:

Delete multiple members in a single request.

Can delete by memberid, mobilephone, email, appmemberid, clientmemberid Can mix identifiers in a single request, i.e. can delete one member by memberid, one member by email, and one member by mobilephone.

Sample success response:

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 2,\n            \"failure\": 0\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"memberid\": 86795319\n                    },\n                    \"result\": \"success\"\n                }\n            },\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"robbie.member@yopmail.com\",\n                        \"memberid\": 86795318\n                    },\n                    \"result\": \"success\"\n                }\n            }\n        ]\n    }\n}\n\n

Sample error response (partial failure, one of the members didn't exist/were already deleted):

status code: 400

{\n    \"body\": {\n        \"results\": {\n            \"success\": 1,\n            \"failure\": 1\n        },\n        \"members\": [\n            {\n                \"member\": {\n                    \"id\": {\n                        \"memberid\": \"86795319\"\n                    },\n                    \"result\": \"failure\",\n                    \"member_errors\": [\n                        {\n                            \"member_error\": {\n                                \"code\": \"MS-ERR-003\",\n                                \"message\": \"Invalid parameter value\",\n                                \"detail\": {\n                                    \"parameter\": [\n                                        \"memberid\"\n                                    ],\n                                    \"reason\": \"Member does not exist\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            },\n            {\n                \"member\": {\n                    \"id\": {\n                        \"email\": \"nakul.sharma@emids.com\",\n                        \"memberid\": 86793779\n                    },\n                    \"result\": \"success\"\n                }\n            }\n        ]\n    }\n}\n\n

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e17042cd-1f4c-4426-9b49-b9d6bc64a4bf"}],"id":"f35a9d04-95a9-4a21-8eec-e11703358967","description":"

Audience API JSON Version

v1.0.1

Parameters for Requests

Parameter	Value	Validation
`mapid`	Allows you to tag each Member instance with a value that can later be used to request information about messages sent because of the API request; if the same value is provided for multiple Members, then you only need to query that value to get information about all the Members at one time.
`clientmemberid`	Use this field to store your own unique identifier value for each Member (e.g., MRN, Patient ID).	Maximum character length: 256; must be unique within the account.
`mobilephone`	Accepted formats: 1-XXX-XXX-XXXX . 1XXXXXXXXXX . XXX-XXX-XXXX . XXXXXXXXXX . (XXX) XXX-XXXX.	Must be a mobile phone number from a carrier that is supported by the mPulse Mobile Platform; must be unique within the account.
`email`	Must be a valid email address format.	Maximum character length: 128; must be unique within the account.
`appmemberid`	Maximum character length: 64.	Must be unique within the account.
`firstname`	Maximum character length: 256.
`lastname`	Maximum character length: 256.
`birthdate`	Accepted date formats: YYYY-MM-DD . MM/DD/YYYY.	Date cannot be in the future.
`gender`	Accepted values: Female . Male.	Case insensitive, but the response will return the value in proper case (e.g., FEMALE).
`preferredlanguage`	Accepted values: English . Spanish.	Case insensitive, but the response will return the value in proper case (e.g., SPANISH).
`address1`	Maximum character length: 256.
`address2`	Maximum character length: 256.
`city`	Maximum character length: 256.
`state`	Accepted values: Full US state names (e.g., California). All accepted values are listed in the “Audience API - Accepted Parameter Values” document.	Case insensitive, but the response will return the value in proper case (e.g., CALIFORNIA).
`zipcode`	Maximum character length: 256.
`country`	Accepted values: Full country names (e.g., United States). All accepted values are listed in the “Audience API - Accepted Parameter Values” document.	Case insensitive, but the response will return the value in proper case (UNITED STATES).
`companyname`	Maximum character length: 256.
`job`	Maximum character length: 256.
`landline`	Accepted formats: 1-XXX-XXX-XXXX . 1XXXXXXXXXX . XXX-XXX-XXXX . XXXXXXXXXX . (XXX) XXX-XXXX.
`fax`	Accepted formats: 1-XXX-XXX-XXXX . 1XXXXXXXXXX . XXX-XXX-XXXX . XXXXXXXXXX . (XXX) XXX-XXXX.
`businessphone`	Accepted formats: 1-XXX-XXX-XXXX . 1XXXXXXXXXX . XXX-XXX-XXXX . XXXXXXXXXX . (XXX) XXX-XXXX.

Single Vs. Multiple Members In Requests

The majority of requests listed are for actions on a single member. You can also do actions on multiple members per request. The general format is listed below, with a single member object enclosed in a member array.

{ \"body\": { \"member\": [ { \"memberid\": \"15996228\" }, { \"memberid\": \"15494188\" } ] } }

\n","event":[{"listen":"prerequest","script":{"id":"15169ff8-a5ed-4410-b370-a95706cb1dc6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2c3881bc-be85-4435-8753-f0de09770041","type":"text/javascript","exec":[""]}}],"_postman_id":"f35a9d04-95a9-4a21-8eec-e11703358967","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"Audience API - XML","item":[{"name":"Get Member ID & Other Unique Identifiers","id":"afbd38cf-7aea-46ac-a482-59bf422a8abf","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Get","value":"lookup"}],"body":{"mode":"formdata","formdata":[]},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?q=13105551212","description":"

Retrieves member ID and unique Identifiers (mobilephone, client member id, app member id, email).

\nCan look up by query. Add query string to url, i.e. ?q={querystring}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Look Up By	Query String
Client Member ID	`<body><member><clientmemberid>{CLIENT_MEMBER_ID}</clientmemberid></member></body>`
Mobile Phone Number	`<body><member><mobilephone>{MOBILE_PHONE_NUMBER}</mobilephone></member></body>`
Email Address	`<body><member><email>{EMAIL_ADDRESS}</email></member></body>`
App Member ID	`<body><member><appmemberid>{APP_MEMBER_ID}</appmemberid></member></body>`

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[{"key":"q","value":"13105551212"}],"variable":[]}},"response":[],"_postman_id":"afbd38cf-7aea-46ac-a482-59bf422a8abf"},{"name":"Get Subscription Statuses","id":"e86d6219-bd65-443f-a4b9-264f2dfbb904","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Get","value":"subscriptions"}],"body":{"mode":"formdata","formdata":[]},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?q=13105551212","description":"

Retrieves member subscription statuses

Can look up by query. Add query string to url, i.e. ?q={querystring}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Look Up By	Query String
Client Member ID	`<body><member><clientmemberid>{CLIENT_MEMBER_ID}</clientmemberid></member></body>`
Mobile Phone Number	`<body><member><mobilephone>{MOBILE_PHONE_NUMBER}</mobilephone></member></body>`
Email Address	`<body><member><email>{EMAIL_ADDRESS}</email></member></body>`
App Member ID	`<body><member><appmemberid>{APP_MEMBER_ID}</appmemberid></member></body>`
Can look up by query {q}:

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[{"key":"q","value":"13105551212"}],"variable":[]}},"response":[],"_postman_id":"e86d6219-bd65-443f-a4b9-264f2dfbb904"},{"name":"Get Member Profile","id":"55d1d2e8-015e-4202-acb2-8ab93bf77408","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Get","value":"lookup"}],"body":{"mode":"formdata","formdata":[]},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?q={{mobile_phone}}","description":"

Retrieves member profile.

Can look up by query. Add query string to url, i.e. ?q={querystring}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Look Up By	Query String
Client Member ID	`<body><member><clientmemberid>{CLIENT_MEMBER_ID}</clientmemberid></member></body>`
Mobile Phone Number	`<body><member><mobilephone>{MOBILE_PHONE_NUMBER}</mobilephone></member></body>`
Email Address	`<body><member><email>{EMAIL_ADDRESS}</email></member></body>`
App Member ID	`<body><member><appmemberid>{APP_MEMBER_ID}</appmemberid></member></body>`

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[{"key":"q","value":"{{mobile_phone}}"}],"variable":[]}},"response":[],"_postman_id":"55d1d2e8-015e-4202-acb2-8ab93bf77408"},{"name":"Get List Subscribers","id":"35825605-ef4d-47f6-97af-324444067e17","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}"},"isInherited":false},"method":"GET","header":[{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Audience-Get","value":"audience"}],"body":{"mode":"formdata","formdata":[]},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members?q={{list_id}}","description":"

Retrieves subscribers for a list.

Can look up by query. Add query string to url, i.e. ?q={querystring}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Filter By	Value	Accepted Values
None	NULL	N/A
SMS subscription status	{SMS_SUB_STATUS}	active . pending . inactive
Email subscription status	{EMAIL_SUB_STATUS}	active . pending . inactive
Secure Message subscription status	{SECURE_MESSAGE_SUB_STATUS}	subscribed . pending . unsubscribed

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[{"key":"q","value":"{{list_id}}"}],"variable":[]}},"response":[],"_postman_id":"35825605-ef4d-47f6-97af-324444067e17"},{"name":"Create Member","event":[{"listen":"test","script":{"id":"887e385f-a79b-4588-8f0e-014ef9b89451","type":"text/javascript","exec":["var jsonObject = xml2Json(responseBody);","","let amid = jsonObject.body.members.member.id.memberid","","pm.environment.set(\"member_id\", amid);"]}}],"id":"7bf33a99-f01e-48dd-957f-501bcd04ce99","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Format","value":"xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tPP-33883821x\n\t\t13105551212\n\t\tpolly.patient@hotmail.com\n\t\tapp238383822\n\t\tPolly\n\t\tPatient\n\t\t2001-01-01\n\t\tfemale\n\t\tENGLISH\n\t\t123 Fake St.\n\t\tApt 6\n\t\tFaketown\n\t\tOhio\n\t\t91607\n\t\tUnited States\n\t\tFake Co.\n\t\tPlumber\n\t\t13105551213\n\t\t13105551213\n\t\t13105551213\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Create a member.

In order to add a member to the mPulse system, the member must have at least one valid contact method/identifier. The identifier must be unique to the account (unless your account is enabled for the Shared Contact feature.)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7bf33a99-f01e-48dd-957f-501bcd04ce99"},{"name":"Create Member & Subscribe","event":[{"listen":"test","script":{"id":"838d214c-aec5-4e3f-a63b-64ecc90e9f83","type":"text/javascript","exec":["var jsonObject = xml2Json(responseBody);","","let amid = jsonObject.body.members.member.id.memberid","","pm.environment.set(\"member_id\", amid);"]}}],"id":"e6cc29f3-7896-4285-ad87-f5fb8d6489de","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Format","value":"xml"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\tPP-33883821x\n\t\t13105551212\n\t\tpolly.patient@hotmail.com\n\t\tapp238383822\n\t\tPolly\n\t\tPatient\n\t\t2001-01-01\n\t\tfemale\n\t\tENGLISH\n\t\t123 Fake St.\n\t\tApt 6\n\t\tFaketown\n\t\tOhio\n\t\t91607\n\t\tUnited States\n\t\tFake Co.\n\t\tPlumber\n\t\t13105551213\n\t\t13105551213\n\t\t13105551213\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Create a single member & subscribe to a list for the channels indicated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6cc29f3-7896-4285-ad87-f5fb8d6489de"},{"name":"Create Multiple Members & Subscribe","event":[{"listen":"test","script":{"id":"7bea19eb-f426-4421-8f1b-97f9b3f43bbe","type":"text/javascript","exec":["var jsonObject = xml2Json(responseBody);","","let amid = jsonObject.body.members.member.id.memberid","","pm.environment.set(\"member_id\", amid);"]}}],"id":"89a37b11-5b2c-4b31-8637-ef9fe648c1ac","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Format","value":"xml"}],"body":{"mode":"raw","raw":"\n {{list_id}}\n \n Polly\n Patient\n 90210\n 13105551212\n \n \n Mikey\n Member\n 91604\n 13105551313\n \n\n\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Create and subscribe multiple members to a list for the channels indicated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"89a37b11-5b2c-4b31-8637-ef9fe648c1ac"},{"name":"Create & Subscribe New Member; Subscribe Existing Member","event":[{"listen":"test","script":{"id":"aa2362c7-abf5-411c-a98f-31c0b246a39f","type":"text/javascript","exec":["var jsonObject = xml2Json(responseBody);","","let amid = jsonObject.body.members.member.id.memberid","","pm.environment.set(\"member_id\", amid);"]}}],"id":"0a666710-56dc-4fea-b37f-848222810d47","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\tPP-33883821x\n\t\t13105551212\n\t\tpolly.patient@hotmail.com\n\t\tapp238383822\n\t\tPolly\n\t\tPatient\n\t\t2001-01-01\n\t\tfemale\n\t\tENGLISH\n\t\t123 Fake St.\n\t\tApt 6\n\t\tFaketown\n\t\tOhio\n\t\t91607\n\t\tUnited States\n\t\tFake Co.\n\t\tPlumber\n\t\t13105551213\n\t\t13105551213\n\t\t13105551213\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Will create and subscribe a new member.

\nWill subscribe an existing member to a list.

\nWill not subscribe a member if unsubscribed; will error if already subscribed.

\nWill not update fields for other than contact information (mobilephone, email, appmember ID) and only if they are null

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a666710-56dc-4fea-b37f-848222810d47"},{"name":"Create & Subscribe New Member; Subscribe or Resubscribe Existing Member Copy","event":[{"listen":"test","script":{"id":"c6d928b3-b6c3-4a55-91ce-9367474f4d57","type":"text/javascript","exec":["var jsonObject = xml2Json(responseBody);","","let amid = jsonObject.body.members.member.id.memberid","","pm.environment.set(\"member_id\", amid);"]}}],"id":"b089b214-5447-4889-9583-ee3f16ef6485","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"POST","header":[{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true"},{"key":"X-Ms-Force-Subscribe-Member","value":"true"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\tPP-33883821x\n\t\t13105551212\n\t\tjpolly.patient@hotmail.com\n\t\tapp238383822\n\t\tPolly\n\t\tPatient\n\t\t2001-01-01\n\t\tfemale\n\t\tENGLISH\n\t\t123 Fake St.\n\t\tApt 6\n\t\tFaketown\n\t\tOhio\n\t\t91607\n\t\tUnited States\n\t\tFake Co.\n\t\tPlumber\n\t\t13105551213\n\t\t13105551213\n\t\t13105551213\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Will create and subscribe a new member.

\nWill subscribe an existing member to a list.

\nWill resubscribe an existing member to a list.

\nWill not update profile information for an existing member -- except for contact information that is null.

\nCreate a single member & subscribe to a list for the channels indicated.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b089b214-5447-4889-9583-ee3f16ef6485"},{"name":"Update Member Profile: All Fields","event":[{"listen":"test","script":{"id":"0e7447d3-3c8c-479a-b749-63215966e2de","type":"text/javascript","exec":[""]}}],"id":"d73279d9-ae5d-49b6-90f1-a58c8a931dd0","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Format","value":"xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t13105551212\n\t\tPollyanna\n\t\tMcPatient\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Will update member

Will overwrite all member profile fields given as parameters and null out any non-included fields (except audience member ID).

Must find member by mobilephone, email, or appmember ID.

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d73279d9-ae5d-49b6-90f1-a58c8a931dd0"},{"name":"Update Member Profile: Included Fields Only","event":[{"listen":"test","script":{"id":"0e7447d3-3c8c-479a-b749-63215966e2de","type":"text/javascript","exec":[""]}}],"id":"5f41bec9-7ecf-4c78-948f-8d0687108c31","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Format","value":"xml"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Update","value":"included_fields_only"}],"body":{"mode":"raw","raw":"\n\t\n\t\t13105551212\n\t\tPollyana\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Update member

Will only update fields included the request.

Can update by memberid, mobilephone, email, clientmemberid, appmemberid

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f41bec9-7ecf-4c78-948f-8d0687108c31"},{"name":"Update Member Profile: Delta","event":[{"listen":"test","script":{"id":"0e7447d3-3c8c-479a-b749-63215966e2de","type":"text/javascript","exec":[""]}}],"id":"e21e7572-a9bc-4ac3-8f08-c85ea6cb7102","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Format","value":"xml"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Audience-Update","value":"delta"}],"body":{"mode":"raw","raw":"\n\t\n\t\t13105551212\n\t\t233polly332\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Update member; only updates fields that are null to some value.

Can look up member by one of:

email, mobile_phone, app_member_id, client_member_id

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e21e7572-a9bc-4ac3-8f08-c85ea6cb7102"},{"name":"Create & Subscribe New Member; Update & Subscribe/Resubscribe Existing Member","event":[{"listen":"test","script":{"id":"90f32516-b627-40f3-a3b2-50147c20f34b","type":"text/javascript","exec":["var jsonObject = xml2Json(responseBody);","","let amid = jsonObject.body.members.member.id.memberid","","pm.environment.set(\"member_id\", amid);"]}}],"id":"8a8dcd81-0166-41ee-a1ee-71186ea23751","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Audience-Update","value":"upsert"},{"key":"X-Ms-Ignore-Error-For-Existing-Members","value":"true"},{"key":"X-Ms-Force-Subscribe-Member","value":"true"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\tPP-33883821x\n\t\t13105551212\n\t\tjosh.levitan@mpulsemobile.com\n\t\tapp238383822\n\t\tPolly\n\t\tPatient\n\t\t2001-01-01\n\t\tfemale\n\t\tENGLISH\n\t\t123 Fake St.\n\t\tApt 6\n\t\tFaketown\n\t\tOhio\n\t\t91607\n\t\tUnited States\n\t\tFake Co.\n\t\tPlumber\n\t\t13105551213\n\t\t13105551213\n\t\t13105551213\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Creates & Subscribes a new Member

Updates and Subscribes an existing Member

Updates and Re-Subscribes an existing Member

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a8dcd81-0166-41ee-a1ee-71186ea23751"},{"name":"Resubscribe Member","event":[{"listen":"test","script":{"id":"0e7447d3-3c8c-479a-b749-63215966e2de","type":"text/javascript","exec":[""]}}],"id":"996d51a0-162d-4c97-ad18-5faef5565d62","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Audience-Update","value":"resub"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\t13105551212\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Updates a Member's subscription status from \"Unsubscribed\" to \"Subscribed\"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"996d51a0-162d-4c97-ad18-5faef5565d62"},{"name":"Unsubscribe Member","event":[{"listen":"test","script":{"id":"0e7447d3-3c8c-479a-b749-63215966e2de","type":"text/javascript","exec":[""]}}],"id":"ae90f63b-0af4-4a3f-b44f-739ef716c026","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"PUT","header":[{"key":"X-Ms-Source","value":"api"},{"key":"Content-Type","value":"application/xml"},{"key":"X-Ms-Format","value":"xml"},{"key":"X-Ms-Audience-Update","value":"unsub"}],"body":{"mode":"raw","raw":"\n\t{{list_id}}\n\t\n\t\t13105551212\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Unsubscribes a Member from one or more channels on a specific list. One list per request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Identifier	Channel
`mobilephone`	SMS
`email`	email
`appmemberid`	push
`appmemberid`	Secure Message

","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae90f63b-0af4-4a3f-b44f-739ef716c026"},{"name":"Delete Member","event":[{"listen":"test","script":{"id":"418aaf60-52e0-4487-9dab-f0b8d219a1c8","type":"text/javascript","exec":[""]}}],"id":"276ebb43-8a30-4bed-866b-efa0e93c466f","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Format","value":"xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t{{member_id}}\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Delete a member.

\nCan delete by memberid, mobilephone, email, appmemberid, clientmemberid

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"276ebb43-8a30-4bed-866b-efa0e93c466f"},{"name":"Delete Member (Multiple)","event":[{"listen":"test","script":{"id":"418aaf60-52e0-4487-9dab-f0b8d219a1c8","type":"text/javascript","exec":[""]}}],"id":"33addada-b6b0-4556-b6e2-66f8e3a492bc","request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}","showPassword":""},"isInherited":false},"method":"DELETE","header":[{"key":"X-Ms-Source","value":"api"},{"key":"X-Ms-Format","value":"xml"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t15996399\n\t\n\t\n\t\t15996404\n\t\n"},"url":"https://ms-api.mpulsemobile.com/accounts/{{account_id}}/members","description":"

Delete multiple members in a single request.

\n","urlObject":{"protocol":"https","path":["accounts","{{account_id}}","members"],"host":["ms-api","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"33addada-b6b0-4556-b6e2-66f8e3a492bc"}],"id":"abf7db42-ffd2-4285-8c8f-bb7a7041041a","description":"

Audience API - XML version

v3.0.0

Scope	Element/Attribute Name	Description
`<body>`	`<results>`	Contains the tags that summarize the results of the request.
`<results>`	`<failure>`	The total number of Member stanzas that had one or more errors.
`<results>`	`<success>`	The total number of Member stanzas that were processed successfully.
`<body>`	`<xml_errors>`	Any XML errors included in the request are detailed here.
`<body>`	`<members>`	The parent tag for all `<member>` stanzas.
`<members>`	`<member>`	There will be one `<member>` stanza for each `<member>` stanza provided in the request.
`<member>`	`<profile>`	Only included for successfully processed records; parent tag for all profile field tags; only fields containing data are included; all profile tags that were included in the request are included in the response.
`<profile>`	`<CITY>`	Returns the exact string value that was provided in the response.
`<profile>`	`<FAX>`	Format: 1XXXXXXXXXX.
`<profile>`	`<DATEADDED>`	Timestamp of when the Member record was created in the account; Format: YYYY-MM-DD HH:MM TZD (e.g., 2017-05-17 09:09 PDT).
`<profile>`	`<FIRSTNAME>`	Returns the exact string value that was provided in the response.
`<profile>`	`<BUSINESS>`	Tag in responses is different from tag in request(`<businessphone>`); format: 1XXXXXXXXXX.
`<profile>`	`<PREFERREDLANGUAGE>`	Value provided in proper case; possible values: ENGLISH . SPANISH.
`<profile>`	`<ADDRESS1>`	Returns the exact string value that was provided in the response.
`<profile>`	`<ADDRESS2>`	Returns the exact string value that was provided in the response.
`<profile>`	`<ZIP>`	Tag in response is different from tag in request (`<zipcode>`); returns the exact string value that was provided in the response.
`<profile>`	`<LASTNAME>`	Returns the exact string value that was provided in the response.
`<profile>`	`<MAPID>`	Returns the exact string value that was provided in the request.
`<profile>`	`<BIRTHDATE>`	Format: YYYY-MM-DD.
`<profile>`	`<APPMEMBERID>`	Returns the exact string value that was provided in the request.
`<profile>`	`<GENDER>`	Value provided in proper case; possible values: FEMALE . MALE.
`<profile>`	`<STATE>`	Value provided in proper case; possible values provided in “Audience API - Accepted Parameter Values”.
`<profile>`	`<JOB>`	Returns the exact string value that was provided in the response.
`<profile>`	`<COUNTRY>`	Value provided in proper case.
`<profile>`	`<CLIENTMEMBERID>`	Returns the exact string value that was provided in the response.
`<profile>`	`<EMAIL>`	Returns the exact string value that was provided in the response.
`<profile>`	`<HOMEPHONE>`	Tag in responses is different from tag in request (`<landline>`); format: 1XXXXXXXXXX.
`<profile>`	`<MOBILEPHONE>`	Format: 1XXXXXXXXXX.
`<member>`	`<id>`	The parent tag for all unique identifier tags provided for the Member in the request.
`<id>`	`<clientmemberid>`	Only included if `<clientmemberid>` was included in the request.
`<id>`	`<mobilephone>`	Only included if `<mobilephone>` was included in the request.
`<id>`	`<email>`	Only included if `<email>` was included in the request.
`<id>`	`<memberid>`	Only included if a Member record was created; automatically generated mPulse unique Member record identifier in your account; this is the Member ID you will use in other API requests.
`<id>`	`<appmemberid>`	Only included if `<appmemberid>` was included in the request.
`<member>`	`<result>`	Possible values: success . failure; success: Request for the Member resulted in the desired action (e.g., created, subscribed, unsubscribed, updated, etc.); failure: Request for the Member contained an error, so desired action did not occur.
`<member>`	`<subscriptions>`	Only included for requests related to subscriptions.
`<subscriptions>`	`<sms>`	Describes Member’s SMS subscription status
`<sms>`	`<status>`	Possible values: ACTIVE . PENDING . INACTIVE.
`<subscriptions>`	`<email>`	Describes the Member’s Email subscription status.
`<email>`	`<status>`	Possible values: ACTIVE . PENDING . INACTIVE.
`<subscriptions>`	`<appmemberid>`	Describes the Member’s Secure Messaging subscription status.
`<appmemberid>`	`<status>`	Possible values: SUBSCRIBED . UNSUBSCRIBED.
`<member>`	`<member_errors>`	Only included when result is “failure”; contains one or more `<member_error>` tags.
`<member_errors>`	`<member_error>`	There will be one `<member_error>`tag for each field in the request that had an error.
`<member_error>`	`<message>`	The high-level error message corresponding to the error code (e.g., “Invalid parameter value”).
`<member_error>`	`<code>`	The error code. All error codes are detailed in “Audience API Error Codes”.
`<member_error>`	`<detail>`	Parent tag for the tags containing detailed information about the error.
`<detail>`	`<reason>`	Reason for the error (e.g., “invalid_format”).
`<detail>`	`<parameter>`	Tag that contains the error (e.g., “MOBILEPHONE”).
`<detail>`	`<value>`	Value provided in the request.

","event":[{"listen":"prerequest","script":{"id":"c0486f8f-cf05-4285-ad5a-1321abb2d42f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5f54f4ed-bef5-443d-90ab-85c6937f7f65","type":"text/javascript","exec":[""]}}],"_postman_id":"abf7db42-ffd2-4285-8c8f-bb7a7041041a","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}}],"id":"d8de8745-5ab8-4e93-b6cc-5bfdaffedee5","description":"

Audience API

The Audience API is a core API for the mPulse platform. It allows you to create, update, and delete members, and subscribe and unsubscribe members to various lists to receive messages.

The Audience API supports both Basic Auth by default and OAuth (requires setup from your Customer Success Manager or Account Manager) for authorization.

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Required	Description
`X-Ms-Format`	Yes	value xml . json
`Parse-XML`	No	value true . false used for the XML API if you want to escape reserved characters like `&`; the legacy version of the API does not escape reserved characters, so include this header if you want the expected behavior
`X-Ms-Source`	Yes	value must be api
`Authorization`	Yes	Basic Auth (can use OAuth with prior setup from your account team)
`X-Ms-Update`	No	Accepted values: included-fields-only; only included fields will be updated; if doing `PUT` and you do not include this header, will update all fields
`X-Ms-Audience-Update`	No	Accepted values: delta . upsert . resub . unsub
`X-Ms-Force-Subscribe-Member`	No	Accepted values: false (default) Members who are unsubscribed will remain unsubscribed. true Members who are unsubscribed will be resubscribed.
`X-Ms-List-Confirm`	No	Accepted values: false (default) Double Opt-in autoresponder will be suppressed . true If enabled, Double Opt-in autoresponder will be sent and member subscribed with status of \"Pending\"
`Send-Welcome-Message`	No	Accepted values true . false
`X-Ms-Async`	No	Accepted values: false (default) Request will be synchronously processed . true Request will be asynchronously processed; set to true if you include more than 500 member objects in your request. If you have the \"Other Callback URL\" set up for your account, results will be posted there.
`X-Ms-API-Version`	No	Accepted values: 1.0 . 2.0 default is 1.0, which returns a 200 OK response for all successful calls. Version 2.0 will return a 202 response for API calls involving member subscriptions and other operations that may be processed asynchronously due to system load. v2.0 is more accurate as to timing of operations finishing. v2.0 should be used in concert with the subscription callback to get confirmation that the request has finished processing, particularly if you are programatically triggering Event Upload API calls to new members or members newly subscribed to different lists. Please see https://mpulsemobile.atlassian.net/wiki/spaces/MPA/overview for information on our callback documentation.

Custom Fields

Custom fields can be set up by your account team or created via self-service in Communication Console. Custom fields are created on an account level. There is no limit to the number of custom fields you can have per account.

Custom fields are accessed according to the name of the field given during setup, e.g. 6.7 or \"a1c_level\": \"6.7\".

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Validation
Single line	Maximum character length: 256
Paragraph	Maximum character length: 8,192
Picklist	Depends on setup
Multi-picklist	Depends on setup in Control Panel; to add or change multiple values for a single field, separate them via pipes, e.g. `dog
Date	Accepted date formats: YYYY-MM-DD . MM/DD/YYYY
Time	Time without time zone

Error Codes

NOTE: Identifiers -- mobile phone, email, app member ID, and client member ID need to be unique in a given account. Mobile phone and email also need to be valid entities. The system will reject adding and/or subscribing members with invalid or malformed phone numbers or email addresses.

When adding or updating members, the API will return information about why a phone number is invalid, if it's not a valid number, if it's a landline, or if it's an unsupported carrier. For example:

{ \"body\": { \"results\": { \"failure\": 1, \"success\": 0 }, \"members\": [ { \"member\": { \"member_errors\": [ { \"member_error\": { \"message\": \"Invalid parameter value\", \"code\": \"MS-ERR-003\", \"detail\": { \"reason\": \"Number is a landline\", \"parameter\": \"MOBILEPHONE\", \"value\": \"18007770133\" } } } ], \"id\": { \"mobilephone\": \"18007770133\" }, \"result\": \"failure\" } } ] } }

Code	Error Message	API
MSERR-000	An error occured	Common
MSERR-001	A required field is missing	Common
MSERR-002	is not in an acceptable format, therefore the record is rejected.	Common
MSERR-003	Invalid parameter value	Common
MSERR-004	Extra parameters specified. Please specify only one of	Common
MSERR-005	A required header is missing	Common
MSERR-006	Multiple values not allowed for header	Common
MSERR-007	Field cannot be empty	Common
MSERR-008	Maximum length for is	Common
MSERR-100	Another member is currently using the email provided	Audience
MSERR-101	Another member is currently using the mobile phone provided	Audience
MSERR-103	Both email and mobile phone cannot be blank. The request must include at least one email or mobile phone number to be valid	Audience
MSERR-104	No new fields to be updated.	Audience
MSERR-105	An error occurred while performing delta update on member data.	Audience
MSERR-106	Cannot subscribe member to the email channel of the list. As configured, the list does not support email as a channel	Audience
MSERR-107	Cannot subscribe member to the email channel of the list. The email address is on the Do Not Contact List	Audience
MSERR-108	Cannot subscribe member to the email channel of the list. The email address has been marked as Hard Bounced	Audience
MSERR-109	Cannot subscribe member to the email channel of the list. The member is already subscribed to the list	Audience
MSERR-110	Cannot subscribe member to the sms channel of the list. As configured, the list does not support sms as a channel	Audience
MSERR-111	Cannot subscribe member to the sms channel of the list. The mobile phone is on the GPRL List	Audience
MSERR-112	Cannot subscribe member to the sms channel of the list. The mobile phone is marked as Hard Bounced	Audience
MSERR-113	Cannot subscribe member to the sms channel of the list. The member is already subscribed to the list	Audience
MSERR-114	Cannot subscribe member to the list. Both Email and Mobile Phone not specified	Audience
MSERR-115	Cannot resubscribe member to the email channel of the list. As configured, the list does not support email as a channel	Audience
MSERR-116	Cannot resubscribe member to the email channel of the list. The member does not belong to the list	Audience
MSERR-117	Cannot resubscribe member to the email channel of the list. The email address is on the Do Not Contact List	Audience
MSERR-118	Cannot resubscribe member to the email channel of the list. The email address has been marked as Hard Bounced	Audience
MSERR-119	Cannot resubscribe member to the email channel of the list. The member is not eligible for resubscription	Audience
MSERR-120	Cannot resubscribe member to the sms channel of the list. As configured, the list does not support sms as a channel	Audience
MSERR-121	Cannot resubscribe member to the sms channel of the list. The member does not belong to the list	Audience
MSERR-122	Cannot resubscribe member to the sms channel of the list. The mobile phone is on the GPRL List	Audience
MSERR-123	Cannot resubscribe member to the sms channel of the list. The mobile phone is marked as Hard Bounced	Audience
MSERR-124	Cannot resubscribe member to the sms channel of the list. The member is not eligible for subscription	Audience
MSERR-125	Cannot resubscribe member to the list. Both Email and Mobile Phone not specified	Audience
MSERR-126	Cannot unsubscribe this member from the email channel of the list. The member does not belong to the list	Audience
MSERR-127	Cannot unsubscribe this member from the email channel of the list. The member is not subscribed to the list	Audience
MSERR-128	Cannot unsubscribe member from the sms channel of the list. The member does not belong to the list	Audience
MSERR-129	Cannot unsubscribe member from the sms channel of the list. The member is not subscribed to the list	Audience
MSERR-130	Cannot unsubscribe member from the list. Both Email and Mobile Phone not specified	Audience
MSERR-131	Member is already on the DNC list. No change has been made to the member’s status	Audience
MSERR-132	Member is not on the DNC list. No change has been made to the member’s status	Audience

Accepted Parameter Values - State and Country

See appendix

Accepted Parameter Values - Preferred Language

NOTE: value must match exactly, i.e. (Afan) Oromo or Latvian, Lettish.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value
`(Afan) Oromo`
`Abkhazian`
`Afar`
`Afrikaans`
`Albanian`
`Amharic`
`Arabic`
`Armenian`
`Assamese`
`Assyrian`
`Aymara`
`Azerbaijani`
`Bashkir`
`Basque`
`Bengali`
`Bhutani`
`Bihari`
`Bislama`
`Bosnian`
`Breton`
`Bulgarian`
`Burmese`
`Byelorussian`
`Cambodian`
`Catalan`
`Chinese`
`Corsican`
`Creole (English)`
`Creole (French)`
`Creole (Portuguese)`
`Creole (Regular)`
`Croatian`
`Czech`
`Danish`
`Dari, Afghan Persian`
`Dutch`
`English`
`Esperanto`
`Estonian`
`Faeroese`
`Fiji`
`Finnish`
`French`
`Frisian`
`Galician`
`Georgian`
`German`
`Greek`
`Greenlandic`
`Guarani`
`Gujarati`
`Hausa`
`Hebrew`
`Hindi`
`Hmong`
`Hungarian`
`Icelandic`
`Indonesian`
`Interlingua`
`Interlingue`
`Inuktitut (Eskimo)`
`Inupiak`
`Irish`
`Italian`
`Japanese`
`Javanese`
`Kannada`
`Karenni (Karen)`
`Kashmiri`
`Kazakh`
`Kinyarwanda`
`Kirghiz`
`Kirundi`
`Korean`
`Kurdish`
`Laotian`
`Latin`
`Latvian, Lettish`
`Lingala`
`Lithuanian`
`Macedonian`
`Malagasy`
`Malay`
`Malayalam`
`Maltese`
`Maori`
`Marathi`
`Moldavian`
`Mongolian`
`Nauru`
`Nepali`
`Norwegian`
`Occitan`
`Oriya`
`Pashto, Pushto`
`Persian`
`Polish`
`Portuguese`
`Punjabi`
`Quechua`
`Rhaeto-Romance`
`Romanian`
`Russian`
`Samoan`
`Sangro`
`Sanskrit`
`Scots Gaelic`
`Serbian`
`Sesotho`
`Setswana`
`Shona`
`Sindhi`
`Singhalese`
`Siswati`
`Slavic (Church)`
`Slavic`
`Slovak`
`Slovenian`
`Somali`
`Spanish`
`Sudanese`
`Swahili`
`Swedish`
`Tagalog`
`Tajik`
`Tamil`
`Tatar`
`Telugu`
`Thai`
`Tibetan`
`Tigrinya`
`Tonga`
`Tsonga`
`Turkish`
`Turkmen`
`Twi`
`Uigur`
`Ukrainian`
`Urdu`
`Uzbek`
`Vietnamese`
`Volapuk`
`Welch`
`Wolof`
`Xhosa`
`Yiddish`
`Yoruba`
`Zhuang`
`Zulu`

Accepted Parameter Values - Gender

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value
`Female`
`Male`
`Transgender`
`Gender Neutral`
`Non-binary`
`Agender`
`Pangender`
`Genderqueer`
`Two-spirit`
`Third Gender`
`Transgender Male`
`Transgender Female`
`Other`

Rate Limiting & Number of Stanzas in Requests

The Audience API is rate limited at 100 requests per minute per account. If this is not sufficient for your needs, please contact your account team to discuss.

You can perform actions on up to 2,000 members in a single request (for most endpoints). You must have the X-Ms-Async: true header set. For a sync request, you can perform actions on up to 20 members in a single request.

\n","event":[{"listen":"prerequest","script":{"id":"adda9a5b-5af7-4c62-9fbd-1f410d908667","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1ce30e8b-6ad8-421b-b348-fd6818577f63","type":"text/javascript","exec":[""]}}],"_postman_id":"d8de8745-5ab8-4e93-b6cc-5bfdaffedee5","auth":{"type":"basic","basic":{},"isInherited":true,"source":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","type":"collection"}}},{"name":"Transactional Messaging API","item":[{"name":"MT Request","id":"54ebea3b-f3d1-42af-b9c8-67fab7f5a03b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mobilephone\": \"{{phone_number}}\",\n \"encoding\": \"ucs-2\",\n \"reference_id\": \"tracking_b3xyx55\",\n \"message\": \"Hello, this is a test message!\"\n}","options":{"raw":{"language":"json"}}},"url":"https://txnapi.mpulsemobile.com/api/v1/accounts/{{account_id}}/message","description":"

MT Request

POST https://txnapi.mpulsemobile.com/api/v1/accounts/{{account_id}}/message

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value	Description	Required
`Content-Type`	`application/json`	Can only be one value.	Yes
`Authorization`	`Basic a3JpmpulseZ4lYW5kYW46dGVxdEBrcmzaG5h`	Basic auth and OAuth supported.	Yes

Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Value	Description	Required
`mobilephone`	13105551212	Member phone number.	Yes
`encoding`	`ucs-2` or `gsm`	Message encoding type. GSM (default) = 160 characters; UCS-2 = 70 characters.	No
`reference_id`	AB-22334455	Message tracking number.	No
`message`	Hello, have a good day.	Message content.	Yes

","urlObject":{"protocol":"https","path":["api","v1","accounts","{{account_id}}","message"],"host":["txnapi","mpulsemobile","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54ebea3b-f3d1-42af-b9c8-67fab7f5a03b"}],"id":"5426dd4a-c5b6-4994-b5e1-65a7ed29df80","description":"

The Transactional Messaging API provides a simple and programmatic way to deliver SMS messages at high volumes without the overhead of managing contact records and contact preferences.

Messages that flow through the transactional system:

Are not associated with a member/contact.
\n
Do not track subscriber preference (Opt-in / Opt-out).
\n
Do not automatically trigger a response (AR).
\n

Member profile data is not stored. The responsibility of phone number verification, retry logic, and Mobile Originating (MO) message handling belongs to mPulse’s customer.

Getting Started

mPulse must enable use of the Transactional Messaging API for your account before use. Be prepared to supply the following for setup.

Performance requirements (such as API TPS)
\n
Expected message volume
\n
Callback endpoints
\n
Credentials to access endpoints or any other required services
\n

Transactional Messaging API does not facilitate any automated response, opt out, or consent handling. As such, customer is responsible for facilitating appropriate respecting recipient out requests and follow-on messaging.

Customers agree to follow applicable laws, regulations, industry standards and guidelines, including the the Telephone Consumer Protection Act, CTIA Messaging Principles and Best Practices and applicable carrier (e.g., AT&T, T-Mobile, etc.) guidelines and/or codes of conduct; and where applicable, the CTIA Short Code Monitoring Handbook, US Short Code Registry Best Practices, and Short Code Registry Acceptable Use Policy.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b6d3c507-5b66-4e8d-b6c5-0d3e5880fed3","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"9574f8ff-4c42-47c8-b950-247249570334","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"5426dd4a-c5b6-4994-b5e1-65a7ed29df80"}],"auth":{"type":"basic","basic":{}},"event":[{"listen":"prerequest","script":{"id":"17433f75-c4c6-437d-94e0-56a0977d27ef","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"b97ccca0-81ac-417c-b745-1fdba2d7258d","type":"text/javascript","packages":{},"exec":[""]}}]}

Authentication

IP Whitelisting

Basic Authentication

How to Include in the Header

OAuth 2.0 Authentication

How to Include in the Header

Summary of Headers

Contact-Based Identifiers vs. Unique Member ID

Contact-Based Identifier Accounts

Unique Member ID Accounts

Description

Path Parameters

Request Body

Member Object Fields

Example Request Body:

Response

Success Response Example

Error Response Example

Error Handling

Possible Error Codes

Subscription Errors

Subscription Error Example

Description

Path Parameters

Query Parameters

Retrieving Multiple Members

Identifying Members

Response

Introduction

Key Differences with the Audience API

Request Headers

Request Body

Root Object

body Object Fields

Example Request Body

Error Response Example

Error Response Structure

Common Error Codes

General Errors

Event Instance Errors

Event Upload Async

Sample Response:

Sample Response:

Event Upload Status

Rate Limits

Member Identification

Account Types and Acceptable Identifiers

Contact-Based Accounts

UMI Accounts

Overview

Request Headers

Parameters

Error Responses (400 OK)

General Notes

Rate Limiting & Number of Stanzas in Requests

Query Parameters

Sample Response:

Sample Success Response:

Sample Error Response (invalid phone number):

Sample Success Response:

Sample Error Response (invalid phone number):

Query Parameters

Sample Response:

Sample Success Response:

Sample Error Response (invalid phone number):

Sample Success Response:

Sample Error Response (invalid phone number):

Query Parameters

Sample Response:

Sample Success Response:

Sample Error Response (invalid email):

Sample Success Response:

Sample Error Response (invalid email):

Introduction

Channels Supported

Request Headers

Request Body

Response

Request Headers

Request Body

`body` Object Fields