{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1da6a725-34a8-4729-b8e4-85ef5a787934","name":"mPulse One API Docs","description":"## Authentication\n\nAPI requests require **Basic Authentication** or **Oauth** authentication in addition to **IP Whitelisting.**\n\n### IP Whitelisting\n\nOnly **whitelisted IP addresses** are enabled for interfacing with mPulse APIs. To get access, please reach out to your Account Representative.\n\n### Basic Authentication\n\nBasic Authentication uses a username and password to authenticate API requests. Basic Auth credentials can be generated using Program Manager.\n\n#### How to Include in the Header\n\n- **Username**: `user@example.com`\n    \n- **Password**: `mypassword`\n    \n\n1. Combine credentials\n    \n    1. [user@example.com](https://mailto:user@example.com):mypassword\n        \n2. **Encode combined credentials in Base64**\n    \n    1. Results in `YOUR_ACCESS_TOKEN`.\n        \n3. Include in header\n    \n    1. `Authorization: Basic YOUR_ACCESS_TOKEN`\n        \n\n---\n\n## OAuth 2.0 Authentication\n\nOAuth 2.0 uses access tokens to authenticate API requests. To generate an Oauth token, review the Oauth section below.\n\n### How to Include in the Header\n\nInclude your access token in the `Authorization` header using the `oauth` scheme.\n\n**Header**:\n\n`Authorization: oauth YOUR_ACCESS_TOKEN`\n\n**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.\n\n---\n\n## Summary of Headers\n\n- `Authorization: Basic base64(username:password)`\n    \n- `Authorization: oauth YOUR_ACCESS_TOKEN`\n    \n\n## Contact-Based Identifiers vs. Unique Member ID\n\n### Contact-Based Identifier Accounts\n\n- Use **`mobile_phone`**, **`email`**, or **`app_member_id`** as unique identifiers.\n    \n- When creating or updating members, you can identify them using these fields or **`id`**.\n    \n\n### Unique Member ID Accounts\n\n- Use **`client_member_id`** as the unique identifier.\n    \n- When creating or updating members, you can identify them using **`client_member_id`** or **`id`**.\n    \n\n**Note:** In both account types, **`id`** (also referred to as Audience Member ID) can always be used to identify a member.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19138020","team":114781,"collectionId":"1da6a725-34a8-4729-b8e4-85ef5a787934","publishedId":"2sAXqnePeg","public":true,"publicUrl":"https://docs.mpulsemobile.com","privateUrl":"https://go.postman.co/documentation/19138020-1da6a725-34a8-4729-b8e4-85ef5a787934","customColor":{"top-bar":"FFFFFF","right-sidebar":"20252c","highlight":"009ED9"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/00a10523-c577-4cb7-bb17-5772098df44e/bVB1bHNlX0xvZ290eXBlX1doaXRlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"20252C","highlight":"009ED9"}},{"name":"light","logo":"https://content.pstmn.io/71e0fd59-5b1c-4e19-a8f2-1bf0d36d5241/bVB1bHNlX0xvZ290eXBlX0NvbG9yLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"20252c","highlight":"009ED9"}}]}},"version":"8.10.1","publishDate":"2024-12-12T05:44:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/71e0fd59-5b1c-4e19-a8f2-1bf0d36d5241/bVB1bHNlX0xvZ290eXBlX0NvbG9yLnBuZw==","logoDark":"https://content.pstmn.io/00a10523-c577-4cb7-bb17-5772098df44e/bVB1bHNlX0xvZ290eXBlX1doaXRlLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/bdb48549acb8eec8de4486fa9bd33d020d03a1e1e067cb977b75450273d390d9","favicon":"https://mpulsemobile.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.mpulsemobile.com/view/metadata/2sAXqnePeg"}