{"info":{"_postman_id":"40f6ecaa-4336-97d2-59dd-0b62468696e1","name":"CONNECT RestAPI - V2","description":"

CONNECT Extended Service is a REST based interface for interacting with your CONNECT communities. This documentation covers all details required to connect and interact with the various resources in a community.

Request Rate Limits and Acceptable Usage

To avoid the possibility of abuse complaints, balance your API requests with your datamart size. For example, when you make hundreds of requests per second to get list or contact details for 20,000 contacts in your datamart, it will look like abuse to our operations team.

Request and Response format

CONNECT Extended Service accepts and returns JSON encoded data.

Supported HTTP methods

CONNECT Extended Service supports the following HTTP methods when interacting with resources

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

HTTP Method	Description
POST	Create a resource
GET	Retrieve a resource or collection of resources
PUT	Update a resource
DELETE	Delete a resource

\n
Note: Other methods may be accepted but they are not supported and should not be used as they may have unpredictable results
\n

Response Codes

All resource requests should return a valid HTTP status code. Included below are a few of the common statuses

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

Code	Description
200	Success, request completed
201	Success, new resource created
204	Success, no content to return (Delete)
400	Bad Request, the request could not be parsed
401	Unauthorized, invalid authentication token or credentials
404	Not Found, resource does not exist
500	Server error, something went wrong on our end

Path

The API endpoint is the following https://api.teksideconnect.com/v2

A username and password will be required, in this case :

Username = Account name

Password = Service Consumer Keys ( Provided by your account manager)

Authentication

CONNECT Extended Service requires consuming applications authenticate requests with an Authentication token appended to the header of the HTTP request. The key value for the authentication token must be Token.

Getting an Authentication Token

The only endpoint in the CONNECT Extended Service that does not always require an authentication token is the Me endpoint. The endpoint supports authentication by token and additionally through HTTP Basic Authentication.

Successful authentication to Me endpoint returns the current account's details, including current authentication token.

\n
Note: Successful authentication with credentials generates a new authentication token and invalidates the old token. See Revoking an Authentication Token for more details.
\n

Authentication example

This is a sample request and response showing the process of authenticating with an Authentication Token

Request to server

GET https://api.example.com/version/me HTTP/1.1\nHost: https://api.example.com/version\nConnection: keep-alive\nAccept: application/json\nCache-Control: no-cache\nToken: mmRbVglAo0CemN/OOiOshA\nContent-Type: application/json\n\n

Response to client

HTTP/1.1 200 OK\nCache-Control: no-cache\nPragma: no-cache\nContent-Type: application/json; charset=utf-8\nExpires: -1\nContent-Length: 378\n{\n  \"data\": {\n    \"username\": \"CommunityUsername\",\n    \"token\": {\n      \"value\": \"mmRbVglAo0CemN/OOiOshA\",\n      \"expiryDate\": \"2015-03-21T11:29:22.26Z\",\n      \"issuedDate\": \"2015-01-12T11:46:42.047Z\"\n    }\n  },\n  \"links\": [\n    {\n      \"self\": \"https://api.example.com/version/me\"\n    },\n    {\n      \"community\": \"https://api.example.com/version/community\"\n    }\n  ]\n}\n\n

\n
Info: For more information about this endpoint please see the Me section of this document.
\n

Revoking an Authentication Token

There may be a time where the current authentication token needs be be invalidated and a new one generated. This can be accomplished by simply re-authenticating with credentials. This process will generate a new authentication token and invalidate the old one.

Uniform response format

The CONNECT uses a single format for all of its standard responses. Responses are expressed in as JSON objects and come in 1 of 2 variations.

Both variations contain the properties data and links. The data property can either be an object or a collection depending whether the response is for single or collection resources respectively.

The links property contains a collection of links related to the current response resource. Links are structured as a key-value pair with a the key representing the related entry and the value being the url for that resource. These links can allow consuming applications to navigate to related resources without the need to hard code urls.

For each successful request that returns a resource, a link entry named self will be included in the links collection. The self entry will always contain the url of the request that generated the current response.

\n
Info: See the relevant sections on Single and Collection resources for more details on the links property values.
\n

Single resource

Responses that represent a single resource will return a response that contains the data and links properties.

The data property will be an object or non-collection type that represents the requested resource.
The links section will typically return a list of key-value entries that point to other resources that are associated to the requested object.

{\n  \"data\": \"Hello World!!\",\n  \"links\": [\n    { \"self\": \"https://api.example.com/version/users/bob/messages/1\" },\n    { \"user\": \"https://api.example.com/version/users/bob\" }\n  ]\n}\n\n

Collection resource

Responses that represent a collection of resources will return a response that contains the data, count and links properties.

The data property will be an object or non-collection type that represents the requested resource.

The counts property gives the total number of entries for the requested resource regardless of how many are returned by the request. This is helpful when implementing paging for a given resource.

The links section will typically return a list of key-value entries that point to other resources that are associated to the requested object. Collections responses will use the id values for the returned resources in the links collection so that consuming applications can easily link to the individual resources easily.

{\n  \"data\": [\n    { \"id\": 1, \"Hello World!!\" },\n    { \"id\": 2, \"How are you?\" },\n    { \"id\": 3, \"APIs are great fun\" },\n    { \"id\": 4, \"Waffles are the best\" }\n  ],\n  \"count\": 4,\n  \"links\": [\n    { \"self\": \"https://api.example.com/version/users/bob/messages\" },\n    { \"1\": \"https://api.example.com/version/users/bob/messages/1\" },\n    { \"2\": \"https://api.example.com/version/users/bob/messages/2\" },\n    { \"3\": \"https://api.example.com/version/users/bob/messages/3\" },\n    { \"4\": \"https://api.example.com/version/users/bob/messages/4\" },\n    { \"user\": \"https://api.example.com/version/users/bob\" }\n  ]\n}\n\n

Document conventions

Throughout the rest of this document placeholder values have been marked with a set of double curly-braces ({{ }}) surrounding a brief description of the value. Please replace these placeholders with appropriate values based on your applications.

Endpoints

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Uniform response format","slug":"uniform-response-format"},{"content":"Document conventions","slug":"document-conventions"},{"content":"Endpoints","slug":"endpoints"}],"owner":"97199","collectionId":"40f6ecaa-4336-97d2-59dd-0b62468696e1","publishedId":"6Z5PXA6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2EA3F2"},"publishDate":"2021-03-12T20:45:57.000Z"},"item":[{"name":"Me","item":[{"name":"Authentication","event":[{"listen":"test","script":{"id":"d3c7486f-96a7-4f3f-89d3-8efe422e641d","exec":["var data = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"token\", data.data.token.value);"],"type":"text/javascript"}}],"id":"f78a4216-db60-fe9f-ea5f-4d319acf72ac","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://{{domain}}/v2/me","urlObject":{"protocol":"https","path":["v2","me"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f78a4216-db60-fe9f-ea5f-4d319acf72ac"}],"id":"553fd593-1826-d492-5fa9-c90f3afb67bb","_postman_id":"553fd593-1826-d492-5fa9-c90f3afb67bb","description":""},{"name":"Addresses","item":[{"name":"Get From Address","id":"c31dbf50-4942-c1c1-356d-931f423ea2f5","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/email_addresses/from/10","urlObject":{"protocol":"https","path":["v2","email_addresses","from","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"23596a3e-eceb-89b9-cd18-e020778676f8","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/from/4"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"250","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 19:44:54 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"61","body":"{\r\n \"data\": {\r\n \"id\": 4,\r\n \"name\": \"Sample Address\",\r\n \"address\": \"sample@testacc1.com\",\r\n \"isDeleted\": false\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/4\"\r\n }\r\n ]\r\n}"},{"id":"64fe0e8d-5a25-cf1f-628d-ae6159678fb6","name":"404 - Not Found","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/from/999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"193","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:18:00 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"2537","body":"{\r\n \"data\": {\r\n \"message\": \"From Address does not exist\",\r\n \"status\": 404\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/10\"\r\n }\r\n}"},{"id":"998923e6-1897-08c1-993c-226fdf35a562","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/from/4"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"192","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:21:49 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"52","body":"{\r\n \"data\": {\r\n \"message\": \"Missing Authorization-Token\",\r\n \"status\": 401\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/4\"\r\n }\r\n}"}],"_postman_id":"c31dbf50-4942-c1c1-356d-931f423ea2f5"},{"name":"Get From Address Collection","id":"00cbe339-8f6f-710d-9ea5-a56c76f5c07a","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/from?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","email_addresses","from"],"host":["{{domain}}"],"query":[{"description":{"content":"

The maximum number of results to return per page. Maximum 25.

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

The page number of the results to return. 0 based index.

\n","type":"text/plain"},"key":"limit","value":"25"}],"variable":[]}},"response":[{"id":"34e8c94d-f120-c151-3aab-632da235cef5","name":"400 - Bad value for limit parameter","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://{{domain}}/v2/email_addresses/from?page=0&limit=777","protocol":"https","host":["{{domain}}"],"path":["v2","email_addresses","from"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"777"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"281","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:20:06 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"160","body":"{\r\n \"data\": {\r\n \"status\": 400,\r\n \"errors\": [\r\n {\r\n \"key\": \"Limit\",\r\n \"value\": \"Limit should be between 1 and 25\"\r\n }\r\n ]\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from?page=0&limit=777\"\r\n }\r\n}"},{"id":"a9687c72-b59a-a436-381b-ada23b9a89ee","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://{{domain}}/v2/email_addresses/from?page=0&limit=25","protocol":"https","host":["{{domain}}"],"path":["v2","email_addresses","from"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"635","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 19:44:19 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"37","body":"{\r\n \"data\": [\r\n {\r\n \"id\": 4,\r\n \"name\": \"Sample Address\",\r\n \"address\": \"sample@testacc1.com\",\r\n \"isDeleted\": false\r\n },\r\n {\r\n \"id\": 5,\r\n \"name\": \"Sample Address\",\r\n \"address\": \"sample_address@testacc1.com\",\r\n \"isDeleted\": false\r\n }\r\n ],\r\n \"count\": 5,\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from?page=1&limit=3\"\r\n },\r\n {\r\n \"4\": \"https://api.teksideconnect.com/v2/email_addresses/from/4\"\r\n },\r\n {\r\n \"5\": \"https://api.teksideconnect.com/v2/email_addresses/from/5\"\r\n }\r\n ]\r\n}"},{"id":"ab8afde1-0294-b113-2b16-ffc1d177e4ce","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://{{domain}}/v2/email_addresses/from?page=0&limit=25","protocol":"https","host":["{{domain}}"],"path":["v2","email_addresses","from"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"206","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:22:18 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"21","body":"{\r\n \"data\": {\r\n \"message\": \"Missing Authorization-Token\",\r\n \"status\": 401\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from?page=0&limit=25\"\r\n }\r\n}"}],"_postman_id":"00cbe339-8f6f-710d-9ea5-a56c76f5c07a"},{"name":"Create From Address","id":"bc7d61a2-8ad4-237b-dd21-97da731f8bae","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample_address@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from","urlObject":{"protocol":"https","path":["v2","email_addresses","from"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"21a0b74f-2385-19c2-2609-89d2414e52df","name":"401 - Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}","disabled":true},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample_address@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"190","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:25:35 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"21","body":"{\r\n \"data\": {\r\n \"message\": \"Missing Authorization-Token\",\r\n \"status\": 401\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from\"\r\n }\r\n}"},{"id":"7b8f1e61-4bdd-5478-adb9-6ba18cee3992","name":"400 - Address already exists","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample_address@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"205","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:23:45 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"43","body":"{\r\n \"data\": {\r\n \"message\": \"Address with the same name already exists.\",\r\n \"status\": 400\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from\"\r\n }\r\n}"},{"id":"864a4daa-9e07-b8e2-e5f3-55ba1a31af1e","name":"400 - Bad content-type in header","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample_address@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"55","name":"Content-Length","description":""},{"key":"Content-Type","value":"text/plain; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:25:09 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"28","body":"Please check content-type should be 'application/json'."},{"id":"f6163cf4-fe7d-7f85-e239-cda4f2eaa6c4","name":"400 - Missing property","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Test\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from"},"status":"Exception","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"197","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:24:44 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"26","body":"{\r\n \"data\": {\r\n \"message\": \"Address and Name both are required\",\r\n \"status\": 400\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from\"\r\n }\r\n}"},{"id":"fe28df93-9770-886e-00a9-f76054bec4a2","name":"201 - Created","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/from"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"364","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 19:43:14 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"42","body":"{\r\n \"data\": {\r\n \"id\": 5,\r\n \"name\": \"Sample Address\",\r\n \"address\": \"sample_address@testacc1.com\",\r\n \"isDeleted\": false\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from\"\r\n },\r\n {\r\n \"fromAddress\": \"https://devapi.inboxmarketer.com:17818/api/v2/email_addresses/from/5\"\r\n }\r\n ]\r\n}"}],"_postman_id":"bc7d61a2-8ad4-237b-dd21-97da731f8bae"},{"name":"Update From Address","id":"50d689c3-136d-d30b-993b-3615695f248f","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from/10","urlObject":{"protocol":"https","path":["v2","email_addresses","from","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"3a834372-97e0-9fb1-f59f-cf99a5df03bb","name":"201 - Created","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/from/4"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"358","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 19:42:35 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"48","body":"{\r\n \"data\": {\r\n \"id\": 4,\r\n \"name\": \"Sample Address\",\r\n \"address\": \"sample@testacc1.com\",\r\n \"isDeleted\": false\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/4\"\r\n },\r\n {\r\n \"fromAddress\": \"https://devapi.inboxmarketer.com:17818/api/v2/email_addresses/from/4\"\r\n }\r\n ]\r\n}"},{"id":"6ad82074-51e9-981b-33bf-18afc2a87765","name":"400 - Missing property","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from/5"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"199","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:28:38 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"57","body":"{\r\n \"data\": {\r\n \"message\": \"Address and Name both are required\",\r\n \"status\": 400\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/5\"\r\n }\r\n}"},{"id":"710abbb8-fba2-46a2-f4ba-0b752c0988da","name":"404 - Not Found","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from/999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"194","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:27:57 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"121","body":"{\r\n \"data\": {\r\n \"message\": \"From Address does not exist\",\r\n \"status\": 404\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/999\"\r\n }\r\n}"},{"id":"980770f1-e3bb-79e1-e688-76aa8ab0f4a1","name":"401 - Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}","disabled":true},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from/10"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"192","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:31:47 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"1234","body":"{\r\n \"data\": {\r\n \"message\": \"Missing Authorization-Token\",\r\n \"status\": 401\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/1\"\r\n }\r\n}"},{"id":"ab748e7d-c26f-56bc-c3ab-56bded43e907","name":"400 - Bad content-type in header","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from/5"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"55","name":"Content-Length","description":""},{"key":"Content-Type","value":"text/plain; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:31:23 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"96","body":"Please check content-type should be 'application/json'."},{"id":"c9a58260-554a-2415-67a8-6c56c8a296ef","name":"400 - Address already exists","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"Sample Address\",\n\"address\": \"sample@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/from/5"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"212","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:30:31 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"201","body":"{\r\n \"data\": {\r\n \"message\": \"Duplicate email address is not allow to update.\",\r\n \"status\": 400\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/5\"\r\n }\r\n}"}],"_postman_id":"50d689c3-136d-d30b-993b-3615695f248f"},{"name":"Delete From Address","id":"7ec7b4af-752d-7a87-f76b-deb7d9b9693a","request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/from/6","urlObject":{"protocol":"https","path":["v2","email_addresses","from","6"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"1b7d45ee-191e-6161-e9a9-a56d9acd3104","name":"401 - Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}","disabled":true}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/from/6"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"192","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:35:04 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"23","body":"{\r\n \"data\": {\r\n \"message\": \"Missing Authorization-Token\",\r\n \"status\": 401\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/6\"\r\n }\r\n}"},{"id":"84c9d5e6-fa05-ddcd-a3e0-d7fbd457b005","name":"200 - OK","originalRequest":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/from/4"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"357","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 19:45:56 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"51","body":"{\r\n \"data\": {\r\n \"id\": 4,\r\n \"name\": \"Sample Address\",\r\n \"address\": \"sample@testacc1.com\",\r\n \"isDeleted\": true\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/4\"\r\n },\r\n {\r\n \"fromAddress\": \"https://devapi.inboxmarketer.com:17818/api/v2/email_addresses/from/4\"\r\n }\r\n ]\r\n}"},{"id":"e0c5bb8c-e0c4-edd4-25d9-fc63fee8f4c0","name":"404 - Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/from/999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"194","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:32:26 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"118","body":"{\r\n \"data\": {\r\n \"message\": \"From Address does not exist\",\r\n \"status\": 404\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/from/999\"\r\n }\r\n}"}],"_postman_id":"7ec7b4af-752d-7a87-f76b-deb7d9b9693a"},{"name":"Retrieve Reply-To Address","id":"08832967-97cd-64d4-b6ae-ee6c7edd7c44","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/reply_to/10","urlObject":{"protocol":"https","path":["v2","email_addresses","reply_to","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"d550ee80-c934-40e7-9ce2-dd2c08fa0875","name":"404 - Not Found","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/reply_to/999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"202","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:45:57 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"176","body":"{\r\n \"data\": {\r\n \"message\": \"Email Address Id does not exist\",\r\n \"status\": 404\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/999\"\r\n }\r\n}"},{"id":"d86113f2-061d-c070-ba01-a7d5974abddd","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/reply_to/6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"247","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:43:00 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"56","body":"{\r\n \"data\": {\r\n \"id\": 6,\r\n \"name\": \"\",\r\n \"address\": \"sample_address@testacc1.com\",\r\n \"isDeleted\": true\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/6\"\r\n }\r\n ]\r\n}"},{"id":"e9e9b031-dd61-47f8-b629-f5d1153b7720","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/reply_to/6"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"196","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:46:21 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"19","body":"{\r\n \"data\": {\r\n \"message\": \"Missing Authorization-Token\",\r\n \"status\": 401\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/6\"\r\n }\r\n}"}],"_postman_id":"08832967-97cd-64d4-b6ae-ee6c7edd7c44"},{"name":"Retrieve Reply-To Address Collection","id":"33eecd1a-7806-bf07-92f4-f067e47ae91c","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/email_addresses/reply_to?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","email_addresses","reply_to"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[{"id":"21fb8172-9404-9414-cb76-abbebf680cf8","name":"400 - Bad value for limit parameter","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://{{domain}}/v2/email_addresses/reply_to?page=0&limit=999","protocol":"https","host":["{{domain}}"],"path":["v2","email_addresses","reply_to"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"999"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"285","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:50:35 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"55","body":"{\r\n \"data\": {\r\n \"status\": 400,\r\n \"errors\": [\r\n {\r\n \"key\": \"Limit\",\r\n \"value\": \"Limit should be between 1 and 25\"\r\n }\r\n ]\r\n },\r\n \"links\": {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to?page=0&limit=999\"\r\n }\r\n}"},{"id":"32574fd2-7c09-b85e-126e-bf753a40f8f6","name":"200 - OK","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://{{domain}}/v2/email_addresses/reply_to?page=0&limit=25","protocol":"https","host":["{{domain}}"],"path":["v2","email_addresses","reply_to"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"1530","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Jun 2017 20:48:59 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"2273","body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"\",\n \"address\": \"sample_test@testacc1.com\",\n \"isDeleted\": false\n },\n {\n \"id\": 2,\n \"name\": \"\",\n \"address\": \"sample2@testacc1.com\",\n \"isDeleted\": false\n },\n {\n \"id\": 3,\n \"name\": \"\",\n \"address\": \"sample3@testacc1.com\",\n \"isDeleted\": false\n },\n {\n \"id\": 4,\n \"name\": \"\",\n \"address\": \"sample4@testacc1.com\",\n \"isDeleted\": true\n }\n ],\n \"count\": 4,\n \"links\": [\n {\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to?page=0&limit=25\"\n },\n {\n \"1\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/1\"\n },\n {\n \"2\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/2\"\n },\n {\n \"3\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/3\"\n },\n {\n \"4\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/4\"\n }\n ]\n}"}],"_postman_id":"33eecd1a-7806-bf07-92f4-f067e47ae91c"},{"name":"Create Reply-To Address","id":"f49302e5-36ab-c16f-cdfe-cc2d8ba64ed9","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"address\": \"sample@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/reply_to","urlObject":{"protocol":"https","path":["v2","email_addresses","reply_to"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"a65707d4-9e04-e266-5bb9-b50560c4a856","name":"CreateReplyTo","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n\"address\": \"sample_address@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/reply_to"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"361","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 10 May 2017 17:41:33 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":"45","body":"{\r\n \"data\": {\r\n \"id\": 6,\r\n \"name\": \"\",\r\n \"address\": \"sample_address@testacc1.com\",\r\n \"isDeleted\": false\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to\"\r\n },\r\n {\r\n \"replyToAddress\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/6\"\r\n }\r\n ]\r\n}"}],"_postman_id":"f49302e5-36ab-c16f-cdfe-cc2d8ba64ed9"},{"name":"Update Reply-To Address","id":"95c9681a-202b-cac4-5e13-a6e936f4364b","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"address\": \"sample@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/reply_to/10","urlObject":{"protocol":"https","path":["v2","email_addresses","reply_to","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"33767109-514a-ff1f-30ad-10b7ff67652b","name":"UpdateReplyTo","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{\n\"address\": \"sample_test@testacc1.com\"\n}"},"url":"https://{{domain}}/v2/email_addresses/reply_to/1"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"360","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 10 May 2017 19:33:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":"3691","body":"{\r\n \"data\": {\r\n \"id\": 1,\r\n \"name\": \"\",\r\n \"address\": \"sample_test@testacc1.com\",\r\n \"isDeleted\": false\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/1\"\r\n },\r\n {\r\n \"replyToAddress\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/1\"\r\n }\r\n ]\r\n}"}],"_postman_id":"95c9681a-202b-cac4-5e13-a6e936f4364b"},{"name":"Delete Reply-To Address","id":"e9864433-c40a-29f5-bf60-68b214076bac","request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/reply_to/10","urlObject":{"protocol":"https","path":["v2","email_addresses","reply_to","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"5d7c6523-602b-389d-dbb1-d37f04c1991f","name":"DeleteReplyTo","originalRequest":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/email_addresses/reply_to/6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"362","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 10 May 2017 19:35:16 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":"100","body":"{\r\n \"data\": {\r\n \"id\": 6,\r\n \"name\": \"\",\r\n \"address\": \"sample_address@testacc1.com\",\r\n \"isDeleted\": true\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/6\"\r\n },\r\n {\r\n \"replyToAddress\": \"https://api.teksideconnect.com/v2/email_addresses/reply_to/6\"\r\n }\r\n ]\r\n}"}],"_postman_id":"e9864433-c40a-29f5-bf60-68b214076bac"}],"id":"b9815502-1427-cc4c-f8b0-86ee24b9359d","description":"

This set of endpoints allows you to manage the two different types of email addresses associated with the envelope information. These addresses have two properties:

From Address\nThis is the address that is used in the FROM portion of the envelope information of your email deployment. Email address that you attempt to set-up as a from address must use authenticated domains. You can retrieve the authenticated domains from the /Domains endpoint.

In addition, each from address has a default From Name that must be defined. This will be used in place of the email address in recipient's inbox. Although this can be changed on a message by message basis, the default will be used if the from name is not specifically defined.

Reply-To Address\nThis is the address that can be used in place of the from address when recipient click \"reply\" in their inbox. This can any email address and does not need to be authenticated in any way but must follow proper email syntax.

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

Property	Description
address	The email address you'd like to use
name	This is the default from name. Only used in from addresses.
isDeleted	Flag to indicated item has been deleted.

","_postman_id":"b9815502-1427-cc4c-f8b0-86ee24b9359d"},{"name":"Campaigns","item":[{"name":"Retrieve Campaign","id":"58a529d0-d7e5-941d-a30d-5fd5e33392c1","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/campaigns/10","urlObject":{"protocol":"https","path":["v2","campaigns","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"d6f3f5fa-f45e-2575-1aa2-533ca8e519b1","name":"GetCampaign","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"461","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 17:17:49 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"26","body":"{\r\n \"data\": {\r\n \"id\": 1,\r\n \"name\": \"Sample_Campaign\",\r\n \"createdOn\": \"2014-07-07T14:15:48.717Z\",\r\n \"isDeleted\": false,\r\n \"lastModifiedDateTime\": \"2017-05-10T13:17:42.763Z\",\r\n \"createdUserId\": 0,\r\n \"lastModifiedUserId\": 0\r\n },\r\n \"links\": [\r\n {\r\n \"self\": \"https://api.teksideconnect.com/v2/campaigns/1\"\r\n },\r\n {\r\n \"messages\": \"https://api.teksideconnect.com/v2/messages?campaign=1\"\r\n }\r\n ]\r\n}"}],"_postman_id":"58a529d0-d7e5-941d-a30d-5fd5e33392c1"},{"name":"Retrieve Campaign Collection","id":"a3769ddf-fe7f-b835-ba3e-4f128a2a1ad4","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/campaigns?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","campaigns"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[{"id":"42877046-dba5-b1a1-1cf5-0fd88313f8d7","name":"GetCampaignCollection","originalRequest":{"header":[],"body":{"mode":"raw","raw":""},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"847","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 17:25:39 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"33","body":"{\r\n \"data\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Sample_Campaign\",\r\n \"createdOn\": \"2014-07-07T14:15:48.717Z\",\r\n \"isDeleted\": false,\r\n \"lastModifiedDateTime\": \"2017-05-10T13:17:42.763Z\",\r\n \"createdUserId\": 0,\r\n \"lastModifiedUserId\": 0\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"Sample_Campaign_2\",\r\n \"createdOn\": \"2015-07-28T10:10:02.547Z\",\r\n \"isDeleted\": false,\r\n \"lastModifiedDateTime\": \"2017-05-10T13:25:32.34Z\",\r\n \"createdUserId\": 0,\r\n \"lastModifiedUserId\": 0\r\n }\r\n ],\r\n \"count\": 3,\r\n \"links\": [\r\n {\r\n \"self\": \"https://devapi.inboxmarketer.com:17818/api/v2/campaigns?page=0&limit=2\"\r\n },\r\n {\r\n \"1\": \"https://devapi.inboxmarketer.com:17818/api/v2/campaigns/1\"\r\n },\r\n {\r\n \"2\": \"https://devapi.inboxmarketer.com:17818/api/v2/campaigns/2\"\r\n }\r\n ]\r\n}"}],"_postman_id":"a3769ddf-fe7f-b835-ba3e-4f128a2a1ad4"},{"name":"Create Campaign","id":"85ee2cf5-7d27-11a9-6ddc-83f4d82b2f77","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"SampleCampaign\"\n}"},"url":"https://{{domain}}/v2/campaigns","urlObject":{"protocol":"https","path":["v2","campaigns"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"85ee2cf5-7d27-11a9-6ddc-83f4d82b2f77"},{"name":"Update Campaign","id":"cc56bf48-14d9-7986-8399-39ebc036251f","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample_Campaign\"\n}"},"url":"https://{{domain}}/v2/campaigns/10","urlObject":{"protocol":"https","path":["v2","campaigns","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc56bf48-14d9-7986-8399-39ebc036251f"},{"name":"Delete Campaign","id":"c7c128e9-1323-b84b-f9fe-181ab0f8499b","request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/campaigns/10","urlObject":{"protocol":"https","path":["v2","campaigns","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7c128e9-1323-b84b-f9fe-181ab0f8499b"}],"id":"d885f226-017f-8112-23da-454fef812a90","description":"

This set of endpoints allows you to manage the Campaigns used to group together Messages as well as Deployments.

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

Property	Description
name	The unique name used to reference campaign.
isDeleted	Flag to indicated item has been deleted.

","_postman_id":"d885f226-017f-8112-23da-454fef812a90"},{"name":"Community","item":[{"name":"Retrieve Community","id":"364f01f8-0839-df8b-4a2a-995628cb3da4","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/community","urlObject":{"protocol":"https","path":["v2","community"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"364f01f8-0839-df8b-4a2a-995628cb3da4"}],"id":"872b1ba9-738e-a049-5aa6-3cd6146136a4","_postman_id":"872b1ba9-738e-a049-5aa6-3cd6146136a4","description":""},{"name":"Contacts","item":[{"name":"Retrieve Contact","id":"3a6f0eab-31fd-7fcf-927c-2d5bd62552b5","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/contacts/10","urlObject":{"protocol":"https","path":["v2","contacts","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a6f0eab-31fd-7fcf-927c-2d5bd62552b5"},{"name":"Retrieve Contact History","id":"9d110e6e-8317-2e6e-04d8-39e9b4b9fbf1","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/contacts/10/history","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","contacts","10","history"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d110e6e-8317-2e6e-04d8-39e9b4b9fbf1"},{"name":"Retrieve Contact Collection","id":"45e69ed6-64bb-bf6c-afba-e147b33c8f15","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/contacts?limit=25&page=0&source=10&segment=10&list=10&subscription=10&orderby=contactid&orderdirection=asc&lastversiondatetime=2017-05-24T11:48:00.000Z&uniqueid=10&email=sample@testacc1.com","description":"

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\n\n\n\n\n\n

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number
orderby	The property used to sort the contacts. Options are contactid or lastmodified	`contactid`	String
orderdirection	The direction you wish to sort the contacts using the orderby option. Options are asc (Ascending) or desc (Descending)	`asc`	String
uniqueid	`Optional` Search for a contact that matches the value you provide for the uniqueid field.	`null`	String
email	`Optional` Search for a contact that matches the value you provide for the email field.	`null`	String
source	`Optional` The source id to filter the collection by.	`null`	Number
segment	`Optional` The segment id to filter the collection by.	`null`	Number
list	`Optional` The list id to filter the collection by.	`null`	Number
subscription	`Optional` The subscription id to filter the collection by.	`null`	Number
lastversiondatetime	`Optional` Date/Time contacts were last modifieid (new version created) after. Format is: YYYY-MM-DDThh:mm:ss.mmm	`null`	DateTime

","urlObject":{"protocol":"https","path":["v2","contacts"],"host":["{{domain}}"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"0"},{"key":"source","value":"10"},{"key":"segment","value":"10"},{"key":"list","value":"10"},{"key":"subscription","value":"10"},{"key":"orderby","value":"contactid"},{"key":"orderdirection","value":"asc"},{"key":"lastversiondatetime","value":"2017-05-24T11:48:00.000Z"},{"key":"uniqueid","value":"10"},{"key":"email","value":"sample@testacc1.com"}],"variable":[]}},"response":[],"_postman_id":"45e69ed6-64bb-bf6c-afba-e147b33c8f15"},{"name":"Retrieve Combined Contact Subscription Collection","id":"4373324f-4e1b-b283-e390-22fd398a62d7","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/contacts/export?limit=25&page=0&source=10&segment=10&list=10&subscription=10&orderby=contactid&orderdirection=asc&lastversiondatetime=2017-05-24T11:48:00.000Z&uniqueid=10&email=sample@testacc1.com","urlObject":{"protocol":"https","path":["v2","contacts","export"],"host":["{{domain}}"],"query":[{"description":{"content":"

The maximum number of results to return per page. \nMaximum limit: 1000 \nDefault: 20

\n","type":"text/plain"},"key":"limit","value":"25"},{"description":{"content":"

The page number of the results to return. 0 based index. Default: 0

\n","type":"text/plain"},"key":"page","value":"0"},{"key":"source","value":"10"},{"key":"segment","value":"10"},{"key":"list","value":"10"},{"key":"subscription","value":"10"},{"key":"orderby","value":"contactid"},{"key":"orderdirection","value":"asc"},{"key":"lastversiondatetime","value":"2017-05-24T11:48:00.000Z"},{"key":"uniqueid","value":"10"},{"key":"email","value":"sample@testacc1.com"}],"variable":[]}},"response":[],"_postman_id":"4373324f-4e1b-b283-e390-22fd398a62d7"},{"name":"Create Contact","id":"38132c55-210e-9d6c-542e-cbb7c0b77198","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"fields\": [\r\n {\r\n \"field\": {\r\n \"id\": {{uniqueField_Id}},\r\n \"name\": \"{{uniqueField_Name}}\",\r\n \"type\": \"{{uniqueField_Type}}\",\r\n \"required\": true\r\n },\r\n \"value\":\"sample_address@testacc1.com\"\r\n },\r\n {\r\n \"field\": {\r\n \"id\": {{optionalField_Id}},\r\n \"name\": \"{{optionalField_Name}}\",\r\n \"type\": \"{{optionalField_Type}}\",\r\n \"required\": false\r\n },\r\n \"value\":\"Inbox Support\"\r\n }\r\n ],\r\n \"subscriptionPermissions\": [\r\n {\r\n \"id\": {{subscription_Id}},\r\n \"name\": \"{{subscription_Name}}\",\r\n \"permission\": \"Express\",\r\n \"permissionCaptureDateTime\": \"2100-01-01T23:59:59Z\"\r\n }\r\n ]\r\n}"},"url":"https://{{domain}}/v2/contacts","description":"

When creating a contact, you will first want to determine the id and meta data for the field that is used as your uniqueID or \"required=true\".

You will also need to determine the id and meta data for the subscription(s) you will be providing permission for.

\n","urlObject":{"protocol":"https","path":["v2","contacts"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"38132c55-210e-9d6c-542e-cbb7c0b77198"},{"name":"UpdateContact","id":"cf7b5860-28fa-cc0d-c014-330793faad6b","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"fields\": [\r\n {\r\n \"field\": {\r\n \"id\": {{uniqueField_Id}},\r\n \"name\": \"{{uniqueField_Name}}\",\r\n \"type\": \"{{uniqueField_Type}}\",\r\n \"required\": true\r\n },\r\n \"value\":\"sample_address@testacc1.com\"\r\n },\r\n {\r\n \"field\": {\r\n \"id\": {{optionalField_Id}},\r\n \"name\": \"{{optionalField_Name}}\",\r\n \"type\": \"{{optionalField_Type}}\",\r\n \"required\": false\r\n },\r\n \"value\":\"Inbox Support\"\r\n }\r\n ],\r\n \"subscriptionPermissions\": [\r\n {\r\n \"id\": {{subscription_Id}},\r\n \"name\": \"{{subscription_Name}}\",\r\n \"permission\": \"Express\",\r\n \"permissionCaptureDateTime\": \"2100-01-01T23:59:59Z\"\r\n }\r\n ]\r\n}"},"url":"https://{{domain}}/v2/contacts/10","urlObject":{"protocol":"https","path":["v2","contacts","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf7b5860-28fa-cc0d-c014-330793faad6b"},{"name":"Retrieve Contact Original Source","id":"072278a0-7cde-9307-df7a-2094389ceed5","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"permission\": \"unsubscribe\"\r\n}"},"url":"https://{{domain}}/v2/contacts/10/originalsource","urlObject":{"protocol":"https","path":["v2","contacts","10","originalsource"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"072278a0-7cde-9307-df7a-2094389ceed5"},{"name":"Retrieve Contact Bounce Details","id":"803aa72d-29d3-465c-e112-d32e61862aac","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"permission\": \"unsubscribe\"\r\n}"},"url":"https://{{domain}}/v2/contacts/10/bouncedetails","urlObject":{"protocol":"https","path":["v2","contacts","10","bouncedetails"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"803aa72d-29d3-465c-e112-d32e61862aac"},{"name":"Retrieve Contact Subscription Collection","id":"ca83b299-c28d-5096-be57-18cd7400b9f9","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{domain}}/v2/contacts/10/subscriptions?limit=25&page=0","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","contacts","10","subscriptions"],"host":["{{domain}}"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"0"}],"variable":[]}},"response":[],"_postman_id":"ca83b299-c28d-5096-be57-18cd7400b9f9"},{"name":"Retrieve Contact Subscription Permission","id":"a94fb1a6-c053-0ffe-f45a-b22e614111ae","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"permission\": \"unsubscribe\"\r\n}"},"url":"https://{{domain}}/v2/contacts/10/subscriptions/{{subscription_id}}","urlObject":{"protocol":"https","path":["v2","contacts","10","subscriptions","{{subscription_id}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a94fb1a6-c053-0ffe-f45a-b22e614111ae"},{"name":"Update Contact Subscription Permission","id":"6f790768-10e8-34c9-e56f-071303b3fed1","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"permission\": \"unsubscribe\",\r\n \"permissionCaptureDateTime\": \"2100-01-01T23:59:59Z\"\r\n}"},"url":"https://{{domain}}/v2/contacts/10/subscriptions/{{subscription_id}}","urlObject":{"protocol":"https","path":["v2","contacts","10","subscriptions","{{subscription_id}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f790768-10e8-34c9-e56f-071303b3fed1"}],"id":"ee413f51-3c06-5419-04fc-3c33346538b3","_postman_id":"ee413f51-3c06-5419-04fc-3c33346538b3","description":""},{"name":"Data Extensions","item":[{"name":"Retrieve Data Extension Details","id":"200542c7-1dfc-4024-95e5-1e2dc0a9e2c0","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/data_extensions/10","urlObject":{"protocol":"https","path":["v2","data_extensions","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"200542c7-1dfc-4024-95e5-1e2dc0a9e2c0"},{"name":"Retrieve Data Extension Collection","id":"40f924f1-9588-49ab-9bf4-ba1230c24178","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/data_extensions?page=0&limit=20","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","data_extensions"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"20"}],"variable":[]}},"response":[],"_postman_id":"40f924f1-9588-49ab-9bf4-ba1230c24178"},{"name":"Create Data Extension","id":"96562e78-97cf-4b13-a38f-b39e231a599c","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"Store List\",\r\n \"dataExtensionStructure\": {\r\n \"mapFields\": [\r\n {\r\n \"contactField\": {\r\n \"id\": 7,\r\n \"name\": \"preferred_store\",\r\n \"type\": \"Number\"\r\n \r\n },\r\n \"dataExtensionField\": {\r\n \r\n \"name\": \"StoreId\",\r\n \"type\": \"Number\"\r\n \r\n }\r\n }\r\n ],\r\n \"dataExtensionFields\": [\r\n {\r\n \r\n \"name\": \"StoreId\",\r\n \"type\": \"Number\",\r\n \"isKeyField\":true\r\n \r\n },\r\n {\r\n \"name\": \"StoreName\",\r\n \"type\": \"Text\",\r\n \"isKeyField\":false\r\n \r\n \r\n },\r\n {\r\n \"name\": \"StoreAddress\",\r\n \"type\": \"Text\",\r\n \"isKeyField\":false\r\n \r\n \r\n },\r\n {\r\n \"name\": \"StoreCity\",\r\n \"type\": \"Text\",\r\n \"isKeyField\":false\r\n \r\n \r\n },\r\n {\r\n \"name\": \"StoreProvince\",\r\n \"type\": \"Text\",\r\n \"isKeyField\":false\r\n \r\n \r\n },\r\n {\r\n \"name\": \"StorePostalCode\",\r\n \"type\": \"Text\",\r\n \"isKeyField\":false\r\n \r\n \r\n },\r\n {\r\n \"name\": \"StorePhoneNum\",\r\n \"type\": \"Text\",\r\n \"isKeyField\":false\r\n \r\n \r\n },\r\n {\r\n \"name\": \"StoreEmail\",\r\n \"type\": \"Text\",\r\n \"isKeyField\":false\r\n \r\n \r\n },\r\n {\r\n \"name\": \"DateStoreOpened\",\r\n \"type\": \"DateTime\",\r\n \"isKeyField\":false\r\n \r\n \r\n }\r\n ]\r\n \r\n }\r\n }"},"url":"https://{{domain}}/v2/data_extensions/","urlObject":{"protocol":"https","path":["v2","data_extensions",""],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"96562e78-97cf-4b13-a38f-b39e231a599c"},{"name":"Delete Data Extension","id":"cd5f3d43-4f2a-4e95-ab69-ddcfbf1f98aa","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/data_extensions/10","urlObject":{"protocol":"https","path":["v2","data_extensions","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd5f3d43-4f2a-4e95-ab69-ddcfbf1f98aa"},{"name":"Retrieve Data Extension Record Details","id":"91efbbf9-9d2b-4575-aa06-ca4bbce79c37","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/data_extensions/10/records/10","urlObject":{"protocol":"https","path":["v2","data_extensions","10","records","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91efbbf9-9d2b-4575-aa06-ca4bbce79c37"},{"name":"Retrieve Data Extension Records Collection","id":"832abc16-aea3-4c2b-b2b8-de41ffc52b35","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/data_extensions/10/records?page=0&limit=20","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","data_extensions","10","records"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"20"}],"variable":[]}},"response":[],"_postman_id":"832abc16-aea3-4c2b-b2b8-de41ffc52b35"},{"name":"Upload Data Extension Records","id":"42bdcb74-3ac1-4053-aab5-d252779956c1","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Records\": [\n \t{\n \t\t\"recordFieldValues\": [\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 1,\n \t\t\t\t\t\"isKeyField\": true\n \t\t\t\t},\n \t\t\t\t\"value\": \"201\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 2,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"StoreA\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 3,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"123 Street Road\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 4,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"Guelph\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 5,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"Ontario\"\n \t\t\t},\n \t\t\t \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 6,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"A1A 1A1\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 7,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"123.123.1234\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 8,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"store-a@domain.com\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 9,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"01/31/2018 23:59:59\"\n \t\t\t}\n \t\t]\n \t},\n \t{\n \t\t\"recordFieldValues\": [\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 1,\n \t\t\t\t\t\"isKeyField\": true\n \t\t\t\t},\n \t\t\t\t\"value\": \"301\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 2,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"StoreB\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 3,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"321 Street Road\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 4,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"Toronto\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 5,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"Ontario\"\n \t\t\t},\n \t\t\t \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 6,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"B1B 1B1\"\n \t\t\t},\n \t\t\t \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 7,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"123.123.1235\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 8,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"store-b@domain.com\"\n \t\t\t},\n \t\t\t{\n \t\t\t\t\"field\": {\n \t\t\t\t\t\"id\": 9,\n \t\t\t\t\t\"isKeyField\": false\n \t\t\t\t},\n \t\t\t\t\"value\": \"01/30/2018 23:59:59\"\n \t\t\t}\n \t\t]\n\t}\n ]\n}"},"url":"https://{{domain}}/v2/data_extensions/10/records/","urlObject":{"protocol":"https","path":["v2","data_extensions","10","records",""],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"42bdcb74-3ac1-4053-aab5-d252779956c1"},{"name":"Delete Data Extension Record","id":"516b21e4-627e-4cec-b443-9a3aa85fa24a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/data_extensions/10/records/10","urlObject":{"protocol":"https","path":["v2","data_extensions","10","records","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"516b21e4-627e-4cec-b443-9a3aa85fa24a"},{"name":"Delete all Data Extension Records","id":"1101d14a-6ca3-4716-bfe9-4ac942ba33d1","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{consumer_user}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/data_extensions/10/clearallrecords","urlObject":{"protocol":"https","path":["v2","data_extensions","10","clearallrecords"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1101d14a-6ca3-4716-bfe9-4ac942ba33d1"}],"id":"a9b9c4c3-981b-4876-bba0-83ecf8fb6489","_postman_id":"a9b9c4c3-981b-4876-bba0-83ecf8fb6489","description":""},{"name":"Deployments","item":[{"name":"State","item":[{"name":"Retrieve Deployment State","id":"a6e44a4c-b7cf-6220-56e7-694828faac70","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/deployments/10/state","description":"

The state of a deployment will tell you at what stage it's at in the deployment cycle. A deployment goes from Scheduled, to Delivering to Finished as part of the normal cycle.

The following status values can be used when updating [PUT] a deployments status:

\"pause\" - Stops the deployment and places it in a state of \"Paused\" where it can be resumed. This state can only be used on a \"Delivering\" deployment.
\n
\"resume\" - Resumes the deployment's normal cycle of delivery. This state can only be used on a \"Paused\" deployment.
\n
\"cancel\" - The result of this action is dependant on the current state of the deployment. If it is scheduled, it will set the state to \"Cancelled\" and it will be removed from the UI. If it is \"Delivering\" or \"Paused\" it will set the state to \"Cancelled\", stop sending to Contacts but will remain in the UI to collect results.
\n

\n","urlObject":{"protocol":"https","path":["v2","deployments","10","state"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6e44a4c-b7cf-6220-56e7-694828faac70"},{"name":"Schedule Deployment","event":[{"listen":"prerequest","script":{"id":"e3366fa6-2e8e-4f0a-97b9-692dc0ff0472","exec":["var dt = new Date();","dt.setHours(dt.getHours() - environment[\"sethours\"]);","postman.setEnvironmentVariable(\"currentdatetime\", dt.toISOString());"],"type":"text/javascript"}}],"id":"8a9cf54e-61eb-4e59-a7c5-6d9328e4a12e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"deployDate\": \"2100-01-01T11:59:59.000Z\"\r\n}"},"url":"https://{{domain}}/v2/deployments/10/schedule","urlObject":{"protocol":"https","path":["v2","deployments","10","schedule"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a9cf54e-61eb-4e59-a7c5-6d9328e4a12e"},{"name":"Update Scheduled Deployment State","id":"c5e11740-f4f3-f18e-2b6f-e6cf5b0ddc0f","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"status\": \"cancel\"\n}"},"url":"https://{{domain}}/v2/deployments/10/state","urlObject":{"protocol":"https","path":["v2","deployments","10","state"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5e11740-f4f3-f18e-2b6f-e6cf5b0ddc0f"}],"id":"e5b9ea07-a437-4324-9805-8a5b7a3977c4","_postman_id":"e5b9ea07-a437-4324-9805-8a5b7a3977c4","description":""},{"name":"Seed","item":[{"name":"Retrieve Seed Deployment Collection","id":"d85acb5a-1d75-3760-1254-fecb995dc25f","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"API Test Deployments_{{currentdatetime}}\",\r\n \"message\": {{testmessage_id}},\r\n \"subscription\": {{subscription_id}},\r\n \"lists\": [\r\n 2\r\n ],\r\n \"sources\": [],\r\n \"segments\": [],\r\n \"type\": \"final\",\r\n \"deployDate\": \"{{currentdatetime}}\" //\"2015-08-26T11:48:00.000Z\"\r\n}"},"url":"https://{{domain}}/v2/deployments/10/seeds","urlObject":{"protocol":"https","path":["v2","deployments","10","seeds"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d85acb5a-1d75-3760-1254-fecb995dc25f"},{"name":"Create Seed Deployment","event":[{"listen":"prerequest","script":{"id":"b6378d60-081c-42ba-9245-fabcf57cca4a","exec":["var dt = new Date();","dt.setHours(dt.getHours() - environment[\"sethours\"]);","postman.setEnvironmentVariable(\"currentdatetime\", dt.toISOString());"],"type":"text/javascript"}}],"id":"eb07ed00-071c-359f-a76c-d476fc6885c1","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Deployment\",\r\n \"message\": 1,\r\n \"subscription\": 1,\r\n \"lists\": [],\r\n \"sources\": [],\r\n \"segments\": [],\r\n \"type\": \"final\",\r\n \"deployDate\": \"2100-01-01T11:59:59.000Z\"\r\n}"},"url":"https://{{domain}}/v2/deployments/10/seeds?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","deployments","10","seeds"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"eb07ed00-071c-359f-a76c-d476fc6885c1"}],"id":"7ad0d13d-ac38-4fd9-8987-4ce293dc1b20","_postman_id":"7ad0d13d-ac38-4fd9-8987-4ce293dc1b20","description":""},{"name":"Retrieve Deployment Details","id":"90311830-3c80-e7f8-7ac7-3587805ba736","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/deployments/10","urlObject":{"protocol":"https","path":["v2","deployments","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"90311830-3c80-e7f8-7ac7-3587805ba736"},{"name":"Retrieve Deployment Collection","id":"fbbd786c-c2a4-ea2f-04a1-49490cb7aa10","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/deployments?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","deployments"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"fbbd786c-c2a4-ea2f-04a1-49490cb7aa10"},{"name":"Create Deployment","event":[{"listen":"prerequest","script":{"id":"77715665-77f3-4999-8672-84e4be39cbad","exec":["var dt = new Date();","dt.setHours(dt.getHours() - environment[\"sethours\"]);","postman.setEnvironmentVariable(\"currentdatetime\", dt.toISOString());"],"type":"text/javascript"}}],"id":"d1d878b6-a816-21d2-4edb-9c0619db98ae","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Deployment\",\r\n \"message\": 1,\r\n \"subscription\": 1,\r\n \"lists\": [],\r\n \"sources\": [],\r\n \"segments\": [],\r\n \"type\": \"final\",\r\n \"deployDate\": \"2100-01-01T11:59:59.000Z\"\r\n}"},"url":"https://{{domain}}/v2/deployments","urlObject":{"protocol":"https","path":["v2","deployments"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1d878b6-a816-21d2-4edb-9c0619db98ae"},{"name":"Update Deployment","event":[{"listen":"prerequest","script":{"id":"e3366fa6-2e8e-4f0a-97b9-692dc0ff0472","exec":["var dt = new Date();","dt.setHours(dt.getHours() - environment[\"sethours\"]);","postman.setEnvironmentVariable(\"currentdatetime\", dt.toISOString());"],"type":"text/javascript"}}],"id":"61186c9d-a9eb-49eb-b7e2-dc03413b09e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Deployment\",\r\n \"message\": 1,\r\n \"subscription\": 1,\r\n \"lists\": [],\r\n \"sources\": [],\r\n \"segments\": [],\r\n \"type\": \"final\",\r\n \"deployDate\": \"2100-01-01T11:59:59.000Z\"\r\n}"},"url":"https://{{domain}}/v2/deployments/10","urlObject":{"protocol":"https","path":["v2","deployments","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"61186c9d-a9eb-49eb-b7e2-dc03413b09e4"},{"name":"Delete Deployment","event":[{"listen":"prerequest","script":{"id":"e3366fa6-2e8e-4f0a-97b9-692dc0ff0472","exec":["var dt = new Date();","dt.setHours(dt.getHours() - environment[\"sethours\"]);","postman.setEnvironmentVariable(\"currentdatetime\", dt.toISOString());"],"type":"text/javascript"}}],"id":"71b5e0cc-3b90-41c2-823a-bd8143270f84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/deployments/10","urlObject":{"protocol":"https","path":["v2","deployments","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"71b5e0cc-3b90-41c2-823a-bd8143270f84"},{"name":"Retrieve Deployment Results","id":"2ec4f2b4-99a9-6d33-8665-1e6aa376b6e4","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/deployments/10/results","urlObject":{"protocol":"https","path":["v2","deployments","10","results"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ec4f2b4-99a9-6d33-8665-1e6aa376b6e4"},{"name":"Retrieve Deployment Source Collection","id":"8378965b-cfba-007a-4323-82edb91c7554","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/deployments/10/sources","urlObject":{"protocol":"https","path":["v2","deployments","10","sources"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8378965b-cfba-007a-4323-82edb91c7554"},{"name":"Retrieve Deployment Segment Collection","id":"5a955e96-f4cb-fadc-8ecc-26972a9f4fb7","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/deployments/10/segments","urlObject":{"protocol":"https","path":["v2","deployments","10","segments"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5a955e96-f4cb-fadc-8ecc-26972a9f4fb7"},{"name":"Retrieve Deployment List Collection","id":"58bf93b2-9381-adeb-fabb-c8edc6555346","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/deployments/10/lists","urlObject":{"protocol":"https","path":["v2","deployments","10","lists"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58bf93b2-9381-adeb-fabb-c8edc6555346"}],"id":"059d5dfa-3663-cb2b-43c2-4f347b076856","_postman_id":"059d5dfa-3663-cb2b-43c2-4f347b076856","description":""},{"name":"Domains","item":[{"name":"Retrieve Domain Details","id":"2a19c0e7-8ded-3d77-04bf-359efa48672a","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/domains/10","urlObject":{"protocol":"https","path":["v2","domains","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a19c0e7-8ded-3d77-04bf-359efa48672a"},{"name":"Retrieve Domain Collection","id":"b5c7df02-2044-d479-8e90-9652bdd33a4f","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/domains?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","domains"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"b5c7df02-2044-d479-8e90-9652bdd33a4f"}],"id":"22bee4f3-4baa-ffbc-1433-336494ee76eb","_postman_id":"22bee4f3-4baa-ffbc-1433-336494ee76eb","description":""},{"name":"Fields","item":[{"name":"Retrieve Field Details","id":"ec60482c-fd68-efc6-e695-3140a24a0031","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/fields/10","urlObject":{"protocol":"https","path":["v2","fields","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec60482c-fd68-efc6-e695-3140a24a0031"},{"name":"Retrieve Field Collection","id":"eb172f9d-0c3d-7368-5b35-1c5980d8dc5b","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/fields?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","fields"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"eb172f9d-0c3d-7368-5b35-1c5980d8dc5b"},{"name":"Create Field","id":"c1e0599e-e999-3a91-6b45-35c6af0fa88a","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"FirstName\",\r\n \"type\": \"text\",\r\n \"required\": false\r\n\r\n}"},"url":"https://{{domain}}/v2/fields","urlObject":{"protocol":"https","path":["v2","fields"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1e0599e-e999-3a91-6b45-35c6af0fa88a"},{"name":"Update Field","id":"8634d2c1-c0f1-ff29-b67d-ab53bc85eb24","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"FirstName\"\r\n}"},"url":"https://{{domain}}/v2/fields/10","urlObject":{"protocol":"https","path":["v2","fields","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8634d2c1-c0f1-ff29-b67d-ab53bc85eb24"},{"name":"Delete Field","id":"e477e074-f4ab-71a4-7ff4-13b2d3e18eee","request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/fields/10","urlObject":{"protocol":"https","path":["v2","fields","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e477e074-f4ab-71a4-7ff4-13b2d3e18eee"}],"id":"94102a95-3e4e-bfe5-194d-b1581e7bb225","_postman_id":"94102a95-3e4e-bfe5-194d-b1581e7bb225","description":""},{"name":"Images","item":[{"name":"Retrieve Image Details","id":"e512bed1-6d26-37ae-02d7-a0be498abc1c","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/images/10","urlObject":{"protocol":"https","path":["v2","images","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e512bed1-6d26-37ae-02d7-a0be498abc1c"},{"name":"Retrieve Image Collection","id":"e56a3c0c-c7ed-56b3-eb18-06ff8bdc1e30","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/images?limit=25&page=0&withcontent=false&status=archived&alttext=4&name=4","description":"

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number
withcontent	Include Base64 encoded image in response.	`false`	True/False
status	Filter out images based on their status. Options are 'active', 'archived' or 'all'	`active`	String
alttext	`Optional` Search for images that contain the string with the altText property.	`null`	String
name	`Optional` Search for images that contain the string with the name property.	`null`	String

","urlObject":{"protocol":"https","path":["v2","images"],"host":["{{domain}}"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"0"},{"key":"withcontent","value":"false"},{"key":"status","value":"archived"},{"key":"alttext","value":"4"},{"key":"name","value":"4"}],"variable":[]}},"response":[],"_postman_id":"e56a3c0c-c7ed-56b3-eb18-06ff8bdc1e30"},{"name":"Create Image","id":"6c3bb610-638b-273c-e843-14152e2c35f5","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"name\": \"Sample_image\",\r\n\t\t\"altText\": \"Image\",\r\n\t\t\"content\": \"iVBORw0KGgoAAAANSUhEUgAAAJYAAACWBAMAAADOL2zRAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAbUExURczMzJaWlqqqqre3t8XFxb6+vrGxsaOjo5ycnIsqcMYAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAECSURBVGje7dIxb4MwGIThizEmowm0c5MhM946wtCdqh0YiYRQxkSRmFFSqf3Z/QxpO5u194yH9AYcg4iIiIiIiIiIiIiwgknTFsfb32SnyXwVoa0t1NDX0eOh/FmUnSbX54EplyKR309a1cLkOgOi1E7TgH1g68UheZcvLaMRuKoToN+kJVOO58AWKqzOG1RlLC3nalm09ZPO0SxodU1b+QKSDe6trumsPApuyRGN83uZ7N6S6WPRewGxnc9r/fnbiu2i83IwJ/kfn4DjazG3/DRgF95aXw6F3K8aOlPj3PKT6x/CW/FZ7ry/92r098u3/LTg3hMREREREREREdF/A3wDWaUlUQvPrT8AAAAASUVORK5CYII=\"\r\n\t}\r\n]"},"url":"https://{{domain}}/v2/images","description":"

Content property must be BASE64 encoded.

\n","urlObject":{"protocol":"https","path":["v2","images"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c3bb610-638b-273c-e843-14152e2c35f5"},{"name":"Update Image","id":"8695c66b-09e5-b76e-38a6-234408f73c54","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample_image\",\n \"altText\": \"Image\"\n}"},"url":"https://{{domain}}/v2/images/10","urlObject":{"protocol":"https","path":["v2","images","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8695c66b-09e5-b76e-38a6-234408f73c54"},{"name":"Delete Image","id":"ff3ffff6-7b15-1d42-2a1a-3907ce67c861","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/images/{{Iid}}","urlObject":{"protocol":"https","path":["v2","images","{{Iid}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff3ffff6-7b15-1d42-2a1a-3907ce67c861"}],"id":"4cabbdc1-2365-29d8-5a79-0e70c46a9ab4","_postman_id":"4cabbdc1-2365-29d8-5a79-0e70c46a9ab4","description":""},{"name":"Lists","item":[{"name":"Retrieve List Details","id":"60da79b3-9c9c-df50-5c04-53dcaafbdade","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/lists/10","urlObject":{"protocol":"https","path":["v2","lists","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60da79b3-9c9c-df50-5c04-53dcaafbdade"},{"name":"Retrieve List Collection","id":"42ce43b9-f211-297e-267f-fc226d41891b","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/lists?limit=25&page=0","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","lists"],"host":["{{domain}}"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"0"}],"variable":[]}},"response":[],"_postman_id":"42ce43b9-f211-297e-267f-fc226d41891b"},{"name":"Create List","id":"f7c98bea-aaa4-af2f-317c-a157404dead1","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"SampleList\",\r\n \"fields\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Email\",\r\n \"type\": \"Email\",\r\n \"required\": true\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"FirstName\",\r\n \"type\": \"Text\",\r\n \"required\": false\r\n },\r\n {\r\n \"id\": 3,\r\n \"name\": \"Lastname\",\r\n \"type\": \"Text\",\r\n \"required\": false\r\n }\r\n ],\r\n \"subscriptionPermissions\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"General\",\r\n \"permission\": \"express\"\r\n }\r\n ],\r\n \"isSeed\": false,\r\n \"permissionLadderOptions\": \"Enable\",\r\n \"isPermissionDateCompareDisable\": false\r\n}"},"url":"https://{{domain}}/v2/lists","urlObject":{"protocol":"https","path":["v2","lists"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7c98bea-aaa4-af2f-317c-a157404dead1"},{"name":"Upload List Contacts","id":"45f87517-3e90-aed3-dfe9-541c3bcd9279","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"contactRecords\":[\n\t\t{\n\t\t \"fieldsValue\":[\n\t\t {\n\t\t \"field\":{\n\t\t \"id\":2,\n\t\t \"name\":\"Email\",\n\t\t \"type\":\"Email\",\n\t\t \"required\":false\n\t\t },\n\t\t \"value\":\"sample_address@testacc1.com\"\n\t\t },\n\t\t {\n\t\t \"field\":{\n\t\t \"id\":1,\n\t\t \"name\":\"Account Number\",\n\t\t \"type\":\"Text\",\n\t\t \"required\":true\n\t\t },\n\t\t \"value\":\"Sample123123123123123123\"\n\t\t }\n\t ],\n\t \"subscriptionPermissions\":[\n\t \t{\n\t \t\t\"id\": 1,\n \t\t\t\t\"name\": \"General\",\n \t\t\t\t\"permission\": \"express\",\n \t\t\t\t\"permissionCaptureDateTime\": \"2100-01-01T11:59:59.000Z\"\n\t \t}\n \t]\n\t\t},\n\t\t{\n\t\t \"fieldsValue\":[\n\t\t {\n\t\t \"field\":{\n\t\t \"id\":2,\n\t\t \"name\":\"Email\",\n\t\t \"type\":\"Email\",\n\t\t \"required\":false\n\t\t },\n\t\t \"value\":\"sample_address_2testacc1.com\"\n\t\t },\n\t\t {\n\t\t \"field\":{\n\t\t \"id\":1,\n\t\t \"name\":\"Account Number\",\n\t\t \"type\":\"Text\",\n\t\t \"required\":true\n\t\t },\n\t\t \"value\":\"Sampl829329303494e\"\n\t\t }\n\t ],\n\t \"subscriptionPermissions\":[\n\t \t{\n\t \t\t\"id\": 1,\n \t\t\t\t\"name\": \"General\",\n \t\t\t\t\"permission\": \"implied\",\n \t\t\t\t\"permissionCaptureDateTime\": \"2100-01-01T11:59:59.000Z\"\n\t \t}\n \t]\n\t\t}\n\t]\n}"},"url":"https://{{domain}}/v2/lists/11/upload","urlObject":{"protocol":"https","path":["v2","lists","11","upload"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45f87517-3e90-aed3-dfe9-541c3bcd9279"}],"id":"0e248483-7921-7061-a120-172b7b5f57f9","_postman_id":"0e248483-7921-7061-a120-172b7b5f57f9","description":""},{"name":"Messages","item":[{"name":"Standard Messages","item":[{"name":"Retrieve Message Details","id":"47ce6817-76d6-52f3-bf98-30787f24c6a2","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/messages/10","urlObject":{"protocol":"https","path":["v2","messages","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47ce6817-76d6-52f3-bf98-30787f24c6a2"},{"name":"Retrieve Message Collection","id":"99c63dd4-dccf-6c54-c66a-f4829ed248a5","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/messages?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","messages"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"99c63dd4-dccf-6c54-c66a-f4829ed248a5"},{"name":"Create Message","id":"3dc001b9-f1b6-3e22-8702-47a9547db6e6","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Message\",\r\n \"description\": \"Sample message for testing CONNECT API\",\r\n \"campaign\": 1,\r\n \"envelope\": {\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": {\r\n \t\"value\": \"This is a sample message\"\r\n }\r\n },\r\n \"content\": {\r\n \t\"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n \t\"text\": \"Sample Text Document\"\r\n },\r\n \"template\": 0,\r\n \"enabled\": true,\r\n \"subjectPrefix\": \"subjectPrefix\",\r\n \"contentRulesEnabled\": true\r\n}\r\n"},"url":"https://{{domain}}/v2/messages/","urlObject":{"protocol":"https","path":["v2","messages",""],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3dc001b9-f1b6-3e22-8702-47a9547db6e6"},{"name":"Update Message","id":"53c40158-fdb1-4900-3f07-8a91bf5c035d","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Message\",\r\n \"description\": \"Sample message for testing CONNECT API\",\r\n \"campaign\": 1,\r\n \"envelope\": {\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": {\r\n \t\"value\": \"This is a sample message\"\r\n }\r\n },\r\n \"content\": {\r\n \t\"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n \t\"text\": \"Sample Text Document\"\r\n },\r\n \"template\": null,\r\n \"enabled\": true,\r\n \"subjectPrefix\": \"subjectPrefix\",\r\n \"contentRulesEnabled\": false\r\n}\r\n"},"url":"https://{{domain}}/v2/messages/10","urlObject":{"protocol":"https","path":["v2","messages","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"53c40158-fdb1-4900-3f07-8a91bf5c035d"},{"name":"Retrieve Message Envelope","id":"883a966e-ecba-8b78-37b1-34624322a2fc","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/55/envelopes","description":"

{{domain}}/v3/Messages/218/envelope

\n","urlObject":{"protocol":"https","path":["v2","messages","55","envelopes"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"9de6b78f-9b13-8a4b-2905-da1df2c02762","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/50/envelopes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"976","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 26 Sep 2017 14:43:49 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"105","body":"{\n \"data\": {\n \"fromAddress\": {\n \"id\": 1,\n \"name\": \"Sample Address\",\n \"address\": \"sample_address@testacc1.com\",\n \"isDeleted\": false\n },\n \"replyToAddress\": {\n \"id\": 2,\n \"name\": \"\",\n \"address\": \"sample@testacc1.com\",\n \"isDeleted\": false\n },\n \"subjectTestingPrefix\": null,\n \"subject\": {\n \"value\": \"This is a sample message\"\n }\n },\n \"links\": [\n {\n \"self\": \"https://{{domain}}/v2/messages/50/envelopes\"\n },\n {\n \"replyToAddress\": \"https://{{domain}}/v2/email_addresses/reply_to/2\"\n },\n {\n \"fromAddress\": \"https://{{domain}}/v2/email_addresses/from/1\"\n },\n {\n \"subject\": \"https://{{domain}}/v2/messages/50/envelopes/subjects\"\n },\n {\n \"messages\": \"https://{{domain}}/v2/messages/50\"\n }\n ]\n}"},{"id":"a90e0752-3073-1f7d-4a11-0d310f2997f4","name":"400 - Bad ID","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/55/envelopes"},"status":"Exception","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"220","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 26 Sep 2017 14:47:38 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"86","body":"{\n \"data\": {\n \"message\": \"The message either is already deleted or does not exists\",\n \"status\": 400\n },\n \"links\": {\n \"self\": \"https://api.teksideconnect.com/v2/messages/55/envelopes\"\n }\n}"}],"_postman_id":"883a966e-ecba-8b78-37b1-34624322a2fc"},{"name":"Update Message Envelope","id":"d5bd4232-30b5-7c54-1a87-941ea580ac39","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": {\r\n \t\"value\": \"This is a sample message\"\r\n }\r\n}"},"url":"https://{{domain}}/v2/messages/10/envelopes","description":"

{{domain}}/v3/Messages/218/envelopes

\n","urlObject":{"protocol":"https","path":["v2","messages","10","envelopes"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5bd4232-30b5-7c54-1a87-941ea580ac39"},{"name":"Retrieve Message Subject","id":"98727cf5-b016-7f20-6f54-942638755123","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/50/envelopes/subjects","description":"

{{domain}}/v3/Messages/218/Subject

\n","urlObject":{"protocol":"https","path":["v2","messages","50","envelopes","subjects"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"236a04f1-135b-f549-ea14-c245f56d4ad9","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/50/envelopes/subjects"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"390","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 26 Sep 2017 14:48:50 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"45","body":"{\n \"data\": {\n \"value\": \"This is a sample message\"\n },\n \"links\": [\n {\n \"self\": \"https://{{domain}}/v2/messages/50/envelopes/subjects\"\n },\n {\n \"messages\": \"https://{{domain}}/v2/messages/50\"\n },\n {\n \"envelopes\": \"https://{{domain}}/v2/messages/50/envelopes\"\n }\n ]\n}"}],"_postman_id":"98727cf5-b016-7f20-6f54-942638755123"},{"name":"Update Message Subject","id":"ff9ba62e-2320-9c71-44ac-632bb05b710c","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"value\": \"This is a sample message\"\r\n}"},"url":"https://{{domain}}/v2/messages/10/envelopes/subjects","description":"

{{domain}}/v3/Messages/218/Subject

\n","urlObject":{"protocol":"https","path":["v2","messages","10","envelopes","subjects"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff9ba62e-2320-9c71-44ac-632bb05b710c"},{"name":"Retrieve Message Content","id":"d6cd3457-407d-63a3-9a6e-0cd0eee22ef2","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/10/contents","description":"

{{domain}}/v3/messages/218/content

\n","urlObject":{"protocol":"https","path":["v2","messages","10","contents"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"e1ea6548-e5f3-9025-2055-1a8728a97b7a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/50/contents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"345","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 26 Sep 2017 14:49:59 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"49","body":"{\n \"data\": {\n \"html\": \"Sample HTML Document\",\n \"text\": \"Sample Text Document\"\n },\n \"links\": [\n {\n \"self\": \"https://{{domain}}/v2/messages/50/contents\"\n },\n {\n \"message\": \"https://{{domain}}/v2/messages/50\"\n }\n ]\n}"}],"_postman_id":"d6cd3457-407d-63a3-9a6e-0cd0eee22ef2"},{"name":"Update Message Content","id":"4ca093d9-c563-6be0-4886-23ba220cb54c","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n\t\"text\": \"Sample Text Document\"\r\n}"},"url":"https://{{domain}}/v2/messages/10/contents","description":"

{{domain}}/v3/messages/218/content

\n","urlObject":{"protocol":"https","path":["v2","messages","10","contents"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ca093d9-c563-6be0-4886-23ba220cb54c"},{"name":"Retrieve Message Links","id":"5dcc620d-470f-a5f4-4718-8a02464df96b","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/10/links","description":"

https://api.teksideconnect.com/v2/messages/357/links

StartFragment

EndFragment

\n","urlObject":{"protocol":"https","path":["v2","messages","10","links"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"66feeb16-4cb6-2c92-d910-d2163fadc313","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/1/links"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"1348","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 26 Sep 2017 14:51:26 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"66","body":"{\n \"data\": [\n {\n \"version\": 0,\n \"links\": [\n {\n \"id\": 25,\n \"index\": 1,\n \"name\": \"WB\",\n \"url\": \"https://api.teksideconnect.com\",\n \"html\": \"Web Version\",\n \"tracked\": true,\n \"deployed\": false\n },\n {\n \"id\": 26,\n \"index\": 2,\n \"name\": \"Logo\",\n \"url\": \"https://api.teksideconnect.com\",\n \"html\": \" $\\\"logo\\\"$ \",\n \"tracked\": true,\n \"deployed\": false\n },\n {\n \"id\": 27,\n \"index\": 3,\n \"name\": \"Unsubscribe\",\n \"url\": \"https://api.teksideconnect.com\",\n \"html\": \"Unsubscribe\",\n \"tracked\": true,\n \"deployed\": false\n }\n ]\n }\n ],\n \"links\": [\n {\n \"self\": \"https://{{domain}}/v2/messages/1/links\"\n }\n ]\n}"},{"id":"e347c837-fbe3-ad0e-3155-ad36440a8db5","name":"404 - Links do not exist","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/50/links"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"188","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 26 Sep 2017 14:53:53 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"102","body":"{\n \"data\": {\n \"message\": \"Message Links does not exist\",\n \"status\": 404\n },\n \"links\": {\n \"self\": \"https://api.teksideconnect.com/v2/messages/50/links\"\n }\n}"}],"_postman_id":"5dcc620d-470f-a5f4-4718-8a02464df96b"},{"name":"Retrieve Message Preview","id":"c0be66cc-610e-6986-a481-de0827c90ccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"previewData\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Email\",\r\n \"value\": \"bcarradine@tekside.io\"\r\n },\r\n {\r\n \"id\": 26,\r\n \"name\": \"testNumber\",\r\n \"value\": 1.25\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{domain}}/v2/messages/10/previews?limit=25&page=0&combination=1","description":"

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number
combination	`Optional` The specific combination version to return.	`null`	Number

","urlObject":{"protocol":"https","path":["v2","messages","10","previews"],"host":["{{domain}}"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"0"},{"key":"combination","value":"1"}],"variable":[]}},"response":[],"_postman_id":"c0be66cc-610e-6986-a481-de0827c90ccc"},{"name":"Create Message Preview","id":"dd564bad-8a84-ea7e-6ad2-29451566ec00","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"requireFields\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Email\",\r\n \"value\": \"sample@testacc1.com\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"City\",\r\n \"value\": \"Toronto\"\r\n }\r\n ]\r\n}"},"url":"https://{{domain}}/v2/messages/10/previews","urlObject":{"protocol":"https","path":["v2","messages","10","previews"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd564bad-8a84-ea7e-6ad2-29451566ec00"}],"id":"ccaabb67-82fa-9358-16c8-c331bf28a689","_postman_id":"ccaabb67-82fa-9358-16c8-c331bf28a689","description":""},{"name":"AB Test Messages","item":[{"name":"Retrieve AB Message Collection","id":"d796a91e-611f-6f55-e7ee-711f9f46a25f","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","messages","abtest"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"d796a91e-611f-6f55-e7ee-711f9f46a25f"},{"name":"Retrieve AB Message Details","id":"ba92e4f2-e2e8-18dc-65ea-059f896f080f","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba92e4f2-e2e8-18dc-65ea-059f896f080f"},{"name":"Create AB Message","id":"0bfdccf9-de3d-3f4a-bfc9-81341b5bbddf","request":{"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Message\",\r\n \"testType\": \"Content\",\r\n \"description\": \"Sample message for testing CONNECT API\",\r\n \"campaign\": 1,\r\n \"envelope\": {\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": [\r\n \t{\r\n \t\t\"versionName\": \"Version C\",\r\n \t\t\"value\": \"This is a sample message\"\r\n \t}\r\n ]\r\n },\r\n \"content\": [\r\n \t{\r\n \t\t\"versionName\": \"Version A\",\r\n \t\t\"html\": \"<\\/head>Sample HTML Document - Version A<\\/body><\\/html>\",\r\n \t\t\"text\": \"Sample Text Document\"\r\n \t},\r\n \t{\r\n \t\t\"versionName\": \"Version B\",\r\n \t\t\"html\": \"<\\/head>Sample HTML Document - Version B<\\/body><\\/html>\",\r\n \t\t\"text\": \"Sample Text Document\"\r\n \t}\r\n ],\r\n \"template\": 0,\r\n \"enabled\": true,\r\n \"subjectPrefix\": \"subjectPrefix\",\r\n \"contentRulesEnabled\": true\r\n}"},"url":"https://{{domain}}/v2/messages/abtest","urlObject":{"protocol":"https","path":["v2","messages","abtest"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0bfdccf9-de3d-3f4a-bfc9-81341b5bbddf"},{"name":"Update AB Message","id":"ae5f70ad-a824-7fe4-5d83-46473d4dcb84","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Message\",\r\n \"testType\": \"Subject\",\r\n \"description\": \"Sample message for testing CONNECT API\",\r\n \"campaign\": 1,\r\n \"envelope\": {\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": [\r\n \t{\r\n \t\t\"versionName\": \"Version A\",\r\n \t\t\"value\": \"This is a sample message - Version A\"\r\n \t},\r\n \t{\r\n \t\t\"versionName\": \"Version B\",\r\n \t\t\"value\": \"This is a sample message - Version B\"\r\n \t}\r\n ]\r\n },\r\n \"content\": [\r\n \t{\r\n \t\t\"versionName\": \"Version C\",\r\n \t\t\"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n \t\t\"text\": \"Sample Text Document\"\r\n \t}\r\n ],\r\n \"template\": 0,\r\n \"enabled\": true,\r\n \"subjectPrefix\": \"subjectPrefix\",\r\n \"contentRulesEnabled\": true\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae5f70ad-a824-7fe4-5d83-46473d4dcb84"},{"name":"Delete AB Message","id":"b4e6c584-afc4-476f-57d6-f18235ae1ead","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4e6c584-afc4-476f-57d6-f18235ae1ead"},{"name":"Retrieve AB Message Envelope","id":"c6f98cd0-54dd-d1bf-ea72-0634d5479b83","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/envelopes","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","envelopes"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6f98cd0-54dd-d1bf-ea72-0634d5479b83"},{"name":"Update AB Message Envelope","id":"d218d9bb-3138-68d8-5c4a-8a7846f8b419","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"fromAddress\": 1,\r\n\t\"fromName\": \"SampleFromName\",\r\n\t\"replyToAddress\": 2,\r\n\t\"subjects\": [\r\n \t{\r\n \t\t\"versionName\": \"Version A\",\r\n \t\t\"value\": \"This is a sample message - Version A\"\r\n \t},\r\n \t{\r\n \t\t\"versionName\": \"Version B\",\r\n \t\t\"value\": \"This is a sample message - Version B\"\r\n \t},\r\n \t{\r\n \t\t\"versionName\": \"Version C\",\r\n \t\t\"value\": \"This is a sample message - Version C\"\r\n \t}\r\n ]\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10/envelopes","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","envelopes"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d218d9bb-3138-68d8-5c4a-8a7846f8b419"},{"name":"Retrieve AB Message Subject Collection","id":"ddefa0b9-57a8-7abb-f075-5674378ca6f2","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/envelopes/subjects","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","envelopes","subjects"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ddefa0b9-57a8-7abb-f075-5674378ca6f2"},{"name":"Retrieve AB Message Subject Version","id":"ac8517dc-8f70-b919-ef5f-dd9280f6de58","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/envelopes/subjects/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","envelopes","subjects","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac8517dc-8f70-b919-ef5f-dd9280f6de58"},{"name":"Create AB Message Subject Version","id":"335518b6-1723-1850-fd2d-1220b542d3fb","request":{"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"versionName\": \"Version D\",\r\n\t\"value\": \"This is a sample message - Version D\"\r\n}\r\n"},"url":"https://{{domain}}/v2/messages/abtest/10/envelopes/subjects","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","envelopes","subjects"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"335518b6-1723-1850-fd2d-1220b542d3fb"},{"name":"Update AB Message Subject Version","id":"2b3bfbbe-2380-d494-ceaf-d6dcc7646033","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"versionName\": \"Version D\",\r\n\t\"value\": \"This is a sample message - Version D\"\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10/envelopes/subjects/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","envelopes","subjects","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b3bfbbe-2380-d494-ceaf-d6dcc7646033"},{"name":"Delete AB Message Subject Version","id":"d547fd47-e5a0-1388-0d35-da54889a077e","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/messages/abtest/10/envelopes/subjects/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","envelopes","subjects","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d547fd47-e5a0-1388-0d35-da54889a077e"},{"name":"Retrieve AB Message Content Collection","id":"98806374-e8d4-976d-fd6c-d5853e63b0d0","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"versionName\": \"Version F\",\r\n \"html\": \" This is version A content

\",\r\n \"text\": \"New Text Content\"\r\n}\r\n\r\n"},"url":"https://{{domain}}/v2/messages/abtest/10/contents","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","contents"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"98806374-e8d4-976d-fd6c-d5853e63b0d0"},{"name":"Retrieve AB Message Content Version","id":"d10cecb9-01ab-6bfc-26c7-1f272290a9fd","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/contents/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","contents","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d10cecb9-01ab-6bfc-26c7-1f272290a9fd"},{"name":"Create AB Message Content Version","id":"6746f9ef-09e4-7b19-c018-aa88bf33cc58","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"versionName\": \"Version D\",\r\n\t\"html\": \"<\\/head>Sample HTML Document - Version D<\\/body><\\/html>\",\r\n\t\"text\": \"Sample Text Document\"\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10/contents","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","contents"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6746f9ef-09e4-7b19-c018-aa88bf33cc58"},{"name":"Update AB Message Content Version","id":"bab2116c-6d03-931d-61fa-7fc5662ab6a8","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"versionName\": \"Version D\",\r\n\t\"html\": \"<\\/head>Sample HTML Document - Version D<\\/body><\\/html>\",\r\n\t\"text\": \"Sample Text Document\"\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10/contents/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","contents","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bab2116c-6d03-931d-61fa-7fc5662ab6a8"},{"name":"Delete AB Message Content Version","id":"8760611f-ec8d-9f4e-b655-80ae62601ddd","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/messages/abtest/10/contents/10","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","contents","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8760611f-ec8d-9f4e-b655-80ae62601ddd"},{"name":"Retrieve AB Message Preview","id":"b886cbc0-f324-e484-5f4d-0745faabf146","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/previews?limit=25&page=0&combination=1&version=1","description":"

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number
combination	`Optional` The specific combination version to return.	`null`	Number
version	`Optional` The specific AB Test version to return.	`null`	Number

","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","previews"],"host":["{{domain}}"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"0"},{"key":"combination","value":"1"},{"key":"version","value":"1"}],"variable":[]}},"response":[],"_postman_id":"b886cbc0-f324-e484-5f4d-0745faabf146"},{"name":"Create AB Message Preview","id":"b6f437fa-bf17-bbc9-0ae0-9d5438dd3a32","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"Version\": 1,\r\n \"requireFields\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Email\",\r\n \"value\": \"sample@testacc1.com\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"City\",\r\n \"value\": \"Toronto\"\r\n }\r\n ]\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10/previews","description":"

https://api.teksideconnect.com/v2/messages/118/previews

\n","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","previews"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6f437fa-bf17-bbc9-0ae0-9d5438dd3a32"}],"id":"e76da36d-baba-f70d-2c3a-3ca5a60afcf8","_postman_id":"e76da36d-baba-f70d-2c3a-3ca5a60afcf8","description":""},{"name":"Trigger Messages","item":[{"name":"Retrieve Trigger Message Collection","id":"6f377f62-e99e-fe99-049c-7fb173ad425d","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/trigger?limit=25&page=0","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","messages","trigger"],"host":["{{domain}}"],"query":[{"key":"limit","value":"25"},{"key":"page","value":"0"}],"variable":[]}},"response":[],"_postman_id":"6f377f62-e99e-fe99-049c-7fb173ad425d"},{"name":"Retrieve Trigger Message Details","id":"7fa594a6-bc40-d0ed-1e0b-ee7f0303e18e","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/trigger/10","urlObject":{"protocol":"https","path":["v2","messages","trigger","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7fa594a6-bc40-d0ed-1e0b-ee7f0303e18e"},{"name":"Create Trigger Message","id":"cd7efb34-4fda-fe59-c5d1-6fbb7d839291","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Message\",\r\n \"description\": \"Sample message for testing CONNECT API\",\r\n \"campaign\": 1,\r\n \"envelope\": {\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": {\r\n \t\"value\": \"This is a sample message\"\r\n }\r\n },\r\n \"content\": {\r\n \t\"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n \t\"text\": \"Sample Text Document\"\r\n },\r\n \"template\": 0,\r\n \"enabled\": true,\r\n \"subjectPrefix\": \"subjectPrefix\"\r\n}\r\n"},"url":"https://{{domain}}/v2/messages/trigger/","urlObject":{"protocol":"https","path":["v2","messages","trigger",""],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd7efb34-4fda-fe59-c5d1-6fbb7d839291"},{"name":"Update Trigger Message","id":"8120eaa4-4330-83ee-1419-73947405f7f7","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Message\",\r\n \"description\": \"Sample message for testing CONNECT API\",\r\n \"campaign\": 1,\r\n \"envelope\": {\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": {\r\n \t\"value\": \"This is a sample message\"\r\n }\r\n },\r\n \"content\": {\r\n \t\"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n \t\"text\": \"Sample Text Document\"\r\n },\r\n \"template\": 0,\r\n \"enabled\": true,\r\n \"subjectPrefix\": \"subjectPrefix\"\r\n}\r\n"},"url":"https://{{domain}}/v2/messages/trigger/10","urlObject":{"protocol":"https","path":["v2","messages","trigger","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8120eaa4-4330-83ee-1419-73947405f7f7"},{"name":"Delete Trigger Message","id":"19e22855-15ce-8128-9542-dc03168299a8","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/trigger/10","urlObject":{"protocol":"https","path":["v2","messages","trigger","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"19e22855-15ce-8128-9542-dc03168299a8"},{"name":"Retrieve Trigger Message Envelope","id":"d3f5957e-cd46-2117-af0b-a1239ab6823b","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/trigger/10/envelopes","urlObject":{"protocol":"https","path":["v2","messages","trigger","10","envelopes"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3f5957e-cd46-2117-af0b-a1239ab6823b"},{"name":"Update Trigger Message Envelope ","id":"5b949600-a911-49cb-7b75-b003527cd910","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"fromAddress\": 1,\r\n \"fromName\": \"SampleFromName\",\r\n \"replyToAddress\": 2,\r\n \"subject\": {\r\n \t\"value\": \"This is a sample message\"\r\n }\r\n}"},"url":"https://{{domain}}/v2/messages/trigger/10/envelopes","urlObject":{"protocol":"https","path":["v2","messages","trigger","10","envelopes"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b949600-a911-49cb-7b75-b003527cd910"},{"name":"Retrieve Trigger Message Subject","id":"2cd4d97c-3f63-0243-c97b-bc1893835157","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/trigger/10/envelopes/subjects","urlObject":{"protocol":"https","path":["v2","messages","trigger","10","envelopes","subjects"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cd4d97c-3f63-0243-c97b-bc1893835157"},{"name":"Update Trigger Message Subject","id":"64c281b8-c158-775f-64c0-b7fd3b560dea","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"value\": \"This is a sample message\"\r\n}"},"url":"https://{{domain}}/v2/messages/trigger/10/envelopes/subjects","urlObject":{"protocol":"https","path":["v2","messages","trigger","10","envelopes","subjects"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"64c281b8-c158-775f-64c0-b7fd3b560dea"},{"name":"Retrieve Trigger Message Content","id":"0f3283b6-c0f3-9d44-5a2f-af7330f8b411","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/trigger/10/contents","urlObject":{"protocol":"https","path":["v2","messages","trigger","10","contents"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f3283b6-c0f3-9d44-5a2f-af7330f8b411"},{"name":"Update Trigger Message Content","id":"091d1948-d03e-3bc3-191c-db005de67afd","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n\t\"text\": \"Sample Text Document\"\r\n}"},"url":"https://{{domain}}/v2/messages/trigger/10/contents","urlObject":{"protocol":"https","path":["v2","messages","trigger","10","contents"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"091d1948-d03e-3bc3-191c-db005de67afd"},{"name":"Retrieve Trigger Message Links","id":"e5d3fdc1-eaac-9660-96c1-e07f504e3cf4","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/trigger/10/links","urlObject":{"protocol":"https","path":["v2","messages","trigger","10","links"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5d3fdc1-eaac-9660-96c1-e07f504e3cf4"}],"id":"80fc468d-5e5b-57fe-abc9-cce412c190aa","_postman_id":"80fc468d-5e5b-57fe-abc9-cce412c190aa","description":""},{"name":"Testing","item":[{"name":"Retrieve Message Test Deployment Collection","id":"f1765426-df7f-64ce-01ab-d60ff435f84c","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"SelectedTestAccountLists\": [],\r\n \"SelectedStakeholderLists\": [215],\r\n \"SelectedStakeholder\": [],\r\n \"SelectedTestAccount\": [],\r\n \"Recipients\": [112],\r\n \"HtmlVersion\": true,\r\n \"TextVersion\":false,\r\n \"SelectedVersions\" : [],\r\n \"MessageType\": 1,\r\n \"CreatorEmailAddress\": \"binita.patel@gatewaytechnolabs.com\",\r\n \"SubjectPrefix\":\"TEST##Firstname default= Binita##_hey!!!##Lastname##_##ID##\",\r\n \"SubscriptionId\": 1\r\n}"},"url":"https://{{domain}}/v2/messages/10/tests?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","messages","10","tests"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[{"id":"6db43415-aabc-5904-afc3-5598f7e8651e","name":"200 Response","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"SelectedTestAccountLists\": [],\r\n \"SelectedStakeholderLists\": [215],\r\n \"SelectedStakeholder\": [],\r\n \"SelectedTestAccount\": [],\r\n \"Recipients\": [112],\r\n \"HtmlVersion\": true,\r\n \"TextVersion\":false,\r\n \"SelectedVersions\" : [],\r\n \"MessageType\": 1,\r\n \"CreatorEmailAddress\": \"binita.patel@gatewaytechnolabs.com\",\r\n \"SubjectPrefix\":\"TEST##Firstname default= Binita##_hey!!!##Lastname##_##ID##\",\r\n \"SubscriptionId\": 1\r\n}"},"url":{"raw":"https://{{domain}}/v2/messages/45/tests?page=0&limit=25","protocol":"https","host":["{{domain}}"],"path":["v2","messages","45","tests"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"708","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 14 Jun 2017 15:55:43 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":"231","body":"{\n \"data\": [\n {\n \"deploymentName\": \"Sample_Test_Deployment\",\n \"deploymentStatus\": \"Completed\",\n \"scheduledDateTime\": \"2017-06-01T13:46:50.44Z\",\n \"delivered\": 1,\n \"bounce\": 0,\n \"complaints\": 0,\n \"deliveryCountAlreadySent\": 1,\n \"opens\": 3,\n \"totalClicks\": 1,\n \"uniqueClicks\": 1,\n \"deploymentStatusId\": 200,\n \"rowNumber\": 1,\n \"totalRows\": 1,\n \"deploymentId\": 134,\n \"formattedScheduledDateTime\": \"2017-06-01 13:46:50\"\n }\n ],\n \"count\": 1,\n \"links\": [\n {\n \"self\": \"https://{{domain}}/v2/messages/1/tests?page=0&limit=25\"\n }\n ]\n}"}],"_postman_id":"f1765426-df7f-64ce-01ab-d60ff435f84c"},{"name":"Create Message Test Deployment","id":"817ba8d7-3d8a-820e-d2f2-cbbbd0478324","request":{"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"SelectedTestAccountLists\": [{{testaccount_sourceid}}],\r\n \"SelectedStakeholderLists\": [{{stakeholder_sourceid}}],\r\n \"SelectedStakeholder\": [{{stakeholder_contactid}}],\r\n \"SelectedTestAccount\": [{{testaccount_contactid}}],\r\n \"Recipients\": [],\r\n \"HtmlVersion\": true,\r\n \"TextVersion\":false,\r\n \"SelectedVersions\" : [],\r\n \"MessageType\": 1,\r\n \"CreatorEmailAddress\": \"sample@testacc1.com\",\r\n \"SubjectPrefix\":\"SampleTest\",\r\n \"SubscriptionId\": 1\r\n}"},"url":"https://{{domain}}/v2/messages/10/test","urlObject":{"protocol":"https","path":["v2","messages","10","test"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"817ba8d7-3d8a-820e-d2f2-cbbbd0478324"}],"id":"6926ed61-fe02-648b-add3-014af9e09675","_postman_id":"6926ed61-fe02-648b-add3-014af9e09675","description":""},{"name":"Rules","item":[{"name":"Standard Message","item":[{"name":"Retrieve Message Content Rule Collection","id":"1f777269-7f73-8ee7-165e-c5a3513b14bd","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"priority\":1,\r\n \"operator\": \"OR\",\r\n \"criterias\": [\r\n {\r\n \"operator\": \"AND\",\r\n \"conditionList\": [\r\n {\r\n \"name\": \"FirstName\",\r\n \"operator\": \"==\",\r\n \"value\": \"name\"\r\n },\r\n {\r\n \"name\": \"ID\",\r\n \"operator\": \"=\",\r\n \"value\": \"7\"\r\n } \r\n ]\r\n }\r\n \r\n ],\r\n \"contentVariables\": [\r\n {\r\n \"name\": \"Only Text\",\r\n \"value\": \"###Today###\"\r\n },\r\n {\r\n \"name\": \"UnsubscribeData\",\r\n \"value\": \"Unsubscribecode\"\r\n },\r\n {\r\n \"name\": \"HTMLMessage\",\r\n \"value\": \"This is standard message.
\\r\\n\\r\\nYour Name:##FirstName Format=\\\"ALLCAPS\\\" Default=\\\"NAME\\\"##

Your ID:##ID Format=\\\"WholeNumber\\\" Default=\\\"56\\\"##

Your Email:##Email##

Your DOB:##DOB Format=\\\"MM/dd/yyyy\\\" Default=\\\"12/12/2012\\\"##

This is test link: Company details

This Image from lib: $\\\"Google\\\"$

This is image from online: http://cdn.shopclues.com/images/banners/11_16oct_jewellery_combos.jpg
\"\r\n },\r\n \r\n {\r\n \"name\": \"Combination\",\r\n \"value\": \"Your Name:##FirstName Format=\\\"ALLCAPS\\\" Default=\\\"NAME\\\"##_Your ID:##ID Format=\\\"WholeNumber\\\" Default=\\\"56\\\"##_Your Email:##Email##_Your DOB:##DOB Format=\\\"MM/dd/yyyy\\\" Default=\\\"12/12/2012\\\"##\"\r\n },\r\n {\r\n \"name\": \"Imagefromonline\",\r\n \"value\": \" $\\\"Shopping\\\"$ \"\r\n },\r\n {\r\n \"name\": \"Webversion\",\r\n \"value\": \"Webversion\"\r\n },\r\n {\r\n \"name\": \"Numeric\",\r\n \"value\": \"01234567890\"\r\n },\r\n \r\n {\r\n \"name\": \"Date\",\r\n \"value\": \"2016-12-27 08:31:21.953\"\r\n },\r\n {\r\n \"name\": \"Longetext\",\r\n \"value\": \"What is .marketing?No one knows better than marketers how important it is to brand your business – including your web address. This new domain allows marketing and ad agencies, PR firms, professional associations and market research companies to craft web addresses that speak for themselves.Your perfect domain name is waiting.With hundreds of new domain extensions coming to the web, finding an address that fits your business is easier than ever. Turn your web address into a promotional tool with your own .marketing.\"\r\n }\r\n \r\n ]\r\n}"},"url":"https://{{domain}}/v2/messages/10/rules?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","messages","10","rules"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"1f777269-7f73-8ee7-165e-c5a3513b14bd"},{"name":"Retrieve Message Content Rule Details","id":"d2c6b27e-5dae-09b7-8223-9eb8c6edbd48","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"priority\":1,\r\n \"operator\": \"OR\",\r\n \"criterias\": [\r\n {\r\n \"operator\": \"AND\",\r\n \"conditionList\": [\r\n {\r\n \"name\": \"FirstName\",\r\n \"operator\": \"==\",\r\n \"value\": \"name\"\r\n },\r\n {\r\n \"name\": \"ID\",\r\n \"operator\": \"=\",\r\n \"value\": \"7\"\r\n } \r\n ]\r\n }\r\n \r\n ],\r\n \"contentVariables\": [\r\n {\r\n \"name\": \"Only Text\",\r\n \"value\": \"###Today###\"\r\n },\r\n {\r\n \"name\": \"UnsubscribeData\",\r\n \"value\": \"Unsubscribecode\"\r\n },\r\n {\r\n \"name\": \"HTMLMessage\",\r\n \"value\": \"This is standard message.
\\r\\n\\r\\nYour Name:##FirstName Format=\\\"ALLCAPS\\\" Default=\\\"NAME\\\"##

Your ID:##ID Format=\\\"WholeNumber\\\" Default=\\\"56\\\"##

Your Email:##Email##

Your DOB:##DOB Format=\\\"MM/dd/yyyy\\\" Default=\\\"12/12/2012\\\"##

This is test link: Company details

This Image from lib: $\\\"Google\\\"$

This is image from online: http://cdn.shopclues.com/images/banners/11_16oct_jewellery_combos.jpg
\"\r\n },\r\n \r\n {\r\n \"name\": \"Combination\",\r\n \"value\": \"Your Name:##FirstName Format=\\\"ALLCAPS\\\" Default=\\\"NAME\\\"##_Your ID:##ID Format=\\\"WholeNumber\\\" Default=\\\"56\\\"##_Your Email:##Email##_Your DOB:##DOB Format=\\\"MM/dd/yyyy\\\" Default=\\\"12/12/2012\\\"##\"\r\n },\r\n {\r\n \"name\": \"Imagefromonline\",\r\n \"value\": \" $\\\"Shopping\\\"$ \"\r\n },\r\n {\r\n \"name\": \"Webversion\",\r\n \"value\": \"Webversion\"\r\n },\r\n {\r\n \"name\": \"Numeric\",\r\n \"value\": \"01234567890\"\r\n },\r\n \r\n {\r\n \"name\": \"Date\",\r\n \"value\": \"2016-12-27 08:31:21.953\"\r\n },\r\n {\r\n \"name\": \"Longetext\",\r\n \"value\": \"What is .marketing?No one knows better than marketers how important it is to brand your business – including your web address. This new domain allows marketing and ad agencies, PR firms, professional associations and market research companies to craft web addresses that speak for themselves.Your perfect domain name is waiting.With hundreds of new domain extensions coming to the web, finding an address that fits your business is easier than ever. Turn your web address into a promotional tool with your own .marketing.\"\r\n }\r\n \r\n ]\r\n}"},"url":"https://{{domain}}/v2/messages/10/rules/{{ruleid}}","urlObject":{"protocol":"https","path":["v2","messages","10","rules","{{ruleid}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2c6b27e-5dae-09b7-8223-9eb8c6edbd48"},{"name":"Create Message Content Rule","id":"fdba7bb6-5030-3098-db4e-bb58bab33217","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"priority\":0,\r\n\t\"operator\": \"OR\",\r\n\t\"criterias\": [\r\n\t\t{\r\n\t\t\t\"operator\": \"AND\",\r\n\t\t\t\"conditionList\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"name\": \"FirstName\",\r\n\t\t\t\t\t\"operator\": \"==\",\r\n\t\t\t\t\t\"value\": \"Name\"\r\n\t\t\t\t},\r\n\t\t\t\t{ \r\n\t\t\t\t\t\"name\": \"ID\",\r\n\t\t\t\t\t\"operator\": \">=\",\r\n\t\t\t\t\t\"value\": \"7\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t],\r\n\t\"contentVariables\": [\r\n\t\t{\r\n\t\t\t\"name\": \"Only Text\",\r\n\t\t\t\"value\": \"Sample Text\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"HTMLMessage\",\r\n\t\t\t\"value\": \"

Sample message.

\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Combination\",\r\n\t\t\t\"value\": \"Your Name:##FirstName Format=\\\"ALLCAPS\\\" Default=\\\"NAME\\\"##_Your ID:##ID Format=\\\"WholeNumber\\\" Default=\\\"56\\\"##_Your Email:##Email##_Your DOB:##DOB Format=\\\"MM/dd/yyyy\\\" Default=\\\"12/12/2012\\\"##\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Webversion\",\r\n\t\t\t\"value\": \"Webversion\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Numeric\",\r\n\t\t\t\"value\": \"01234567890\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Date\",\r\n\t\t\t\"value\": \"2016-12-27 08:31:21.953\"\r\n\t\t}\r\n\t]\r\n}"},"url":"https://{{domain}}/v2/messages/10/rules/{{ruleid}}","urlObject":{"protocol":"https","path":["v2","messages","10","rules","{{ruleid}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"604f4a99-ffdf-c2d0-476e-8e28caac6f4d"},{"name":"Upload Message Content Rules","id":"e653e506-4fdc-7b7c-dcc1-eb635b0f1685","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"contentRules\" : [\r\n\t\t{ \r\n \t\t\"criterias\": [\r\n \t\t{\r\n \t\t\t\"conditionList\": [\r\n \t\t\t\t{\r\n \t\t\t\t\t\"name\": \"FirstName\",\r\n \t\t\t\t\t\"operator\": \"contains\",\r\n \t\t\t\t\t\"value\": \"SampleName\"\r\n \t\t\t\t},\r\n \t\t\t\t{\r\n \t\t\t\t\t\"name\": \"Permission-level\",\r\n \t\t\t\t\t\"operator\": \"==\",\r\n \t\t\t\t\t\"value\": \"Express\"\r\n \t\t\t\t}\r\n \t\t\t]\r\n \t\t}\r\n \t],\r\n \t\"contentVariables\": [ \r\n \t\t{\r\n \t\t\t\"name\": \"Variable1\",\r\n \t\t\t\"value\": \"Sample Value1\"\r\n \t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"Variable2\",\r\n \t\t\t\"value\": \"Sample Value2\"\r\n \t\t}\r\n \t]\r\n\t\t},\r\n\t\t{ \r\n\t\t\t\"criterias\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"conditionList\": [\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\": \"FirstName\",\r\n\t\t\t\t\t\t\t\"operator\": \"==\",\r\n\t\t\t\t\t\t\t\"value\": \"SampleName2\"\r\n\t\t\t\t\t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"DOB\",\r\n \t\t\t\"operator\": \"==\",\r\n \t\t\t\"value\": \"2016/06/05\"\r\n \t\t}\r\n \t]\r\n\t\t\t\t}\r\n \t],\r\n \t\"contentVariables\": [\r\n \t\t{\r\n \t\t\t\"name\": \"Variable2\",\r\n \t\t\t\"value\": \"Sample Value2\"\r\n \t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"Variable3\",\r\n \t\t\t\"value\": \"Sample Value3\"\r\n \t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"Variable4\",\r\n \t\t\t\"value\": \"Sample Value4\"\r\n \t\t}\r\n \t]\r\n\t\t}\r\n\t]\r\n}"},"url":"https://{{domain}}/v2/messages/10/uploadrules","urlObject":{"protocol":"https","path":["v2","messages","10","uploadrules"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e653e506-4fdc-7b7c-dcc1-eb635b0f1685"},{"name":"Delete Message Content Rule","id":"67f2071e-7d28-345a-a818-9c8f5272386d","request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/messages/10/rules/{{ruleid}}","urlObject":{"protocol":"https","path":["v2","messages","10","rules","{{ruleid}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"67f2071e-7d28-345a-a818-9c8f5272386d"},{"name":"Delete All Message Content Rules","id":"3ae81853-ad77-5786-950e-b8bad1e607db","request":{"method":"DELETE","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/messages/10/clearallrules","urlObject":{"protocol":"https","path":["v2","messages","10","clearallrules"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ae81853-ad77-5786-950e-b8bad1e607db"}],"id":"7ff3ff24-b87f-3021-07c1-160c0b3f9fc6","_postman_id":"7ff3ff24-b87f-3021-07c1-160c0b3f9fc6","description":""},{"name":"AB Test Message","item":[{"name":"Retrieve AB Message Content Rule Collectoin","id":"2cac3d58-3ab3-c42f-5bab-9d84fc28acf6","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/rules/","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","rules",""],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cac3d58-3ab3-c42f-5bab-9d84fc28acf6"},{"name":"Retrieve AB Message Content Rule Details","id":"93c09113-6539-e106-e90d-1d8ec604a2f3","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/rules/{{ruleid}}","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","rules","{{ruleid}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"93c09113-6539-e106-e90d-1d8ec604a2f3"},{"name":"Create AB Message Content Rule","id":"26827863-0077-37b8-9dd9-cd637f5a9596","request":{"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/messages/abtest/10/rules","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","rules"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"26827863-0077-37b8-9dd9-cd637f5a9596"},{"name":"Update AB Message Content Rule","id":"43978545-a314-f7c6-d724-23a9fe7c0e02","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"priority\":1,\r\n\t\"operator\": \"OR\",\r\n\t\"criterias\": [\r\n\t\t{\r\n\t\t\t\"operator\": \"AND\",\r\n\t\t\t\"conditionList\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"name\": \"FirstName\",\r\n\t\t\t\t\t\"operator\": \"==\",\r\n\t\t\t\t\t\"value\": \"Name\"\r\n\t\t\t\t},\r\n\t\t\t\t{ \r\n\t\t\t\t\t\"name\": \"ID\",\r\n\t\t\t\t\t\"operator\": \">=\",\r\n\t\t\t\t\t\"value\": \"7\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t],\r\n\t\"contentVariables\": [\r\n\t\t{\r\n\t\t\t\"name\": \"Only Text\",\r\n\t\t\t\"value\": \"Sample Text\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"HTMLMessage\",\r\n\t\t\t\"value\": \"

Sample message.

\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Combination\",\r\n\t\t\t\"value\": \"Your Name:##FirstName Format=\\\"ALLCAPS\\\" Default=\\\"NAME\\\"##_Your ID:##ID Format=\\\"WholeNumber\\\" Default=\\\"56\\\"##_Your Email:##Email##_Your DOB:##DOB Format=\\\"MM/dd/yyyy\\\" Default=\\\"12/12/2012\\\"##\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Webversion\",\r\n\t\t\t\"value\": \"Webversion\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Numeric\",\r\n\t\t\t\"value\": \"01234567890\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"Date\",\r\n\t\t\t\"value\": \"2016-12-27 08:31:21.953\"\r\n\t\t}\r\n\t]\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10/rules/{{ruleid}}","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","rules","{{ruleid}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"43978545-a314-f7c6-d724-23a9fe7c0e02"},{"name":"Update AB Message Content Rule Version Setting","id":"94b66ec1-1abe-1212-33db-82cdde8e8d2a","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"enable\": \"true\",\r\n\t\"keepTestVersionId\":1\r\n}"},"url":"{{url}}/v2/messages/ABTest/78/rules/UniqueTestVersionContentRules","urlObject":{"path":["v2","messages","ABTest","78","rules","UniqueTestVersionContentRules"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"94b66ec1-1abe-1212-33db-82cdde8e8d2a"},{"name":"Upload AB Message Content Rules","id":"ae370adc-f117-388d-c5be-3e9eaf7ad18e","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"abTestVersionId\" :[1] ,\r\n \"contentRules\" : [\r\n\t\t{ \r\n \t\t\"criterias\": [\r\n \t\t{\r\n \t\t\t\"conditionList\": [\r\n \t\t\t\t{\r\n \t\t\t\t\t\"name\": \"FirstName\",\r\n \t\t\t\t\t\"operator\": \"contains\",\r\n \t\t\t\t\t\"value\": \"SampleName\"\r\n \t\t\t\t},\r\n \t\t\t\t{\r\n \t\t\t\t\t\"name\": \"Permission-level\",\r\n \t\t\t\t\t\"operator\": \"==\",\r\n \t\t\t\t\t\"value\": \"Express\"\r\n \t\t\t\t}\r\n \t\t\t]\r\n \t\t}\r\n \t],\r\n \t\"contentVariables\": [ \r\n \t\t{\r\n \t\t\t\"name\": \"Variable1\",\r\n \t\t\t\"value\": \"Sample Value1\"\r\n \t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"Variable2\",\r\n \t\t\t\"value\": \"Sample Value2\"\r\n \t\t}\r\n \t]\r\n\t\t},\r\n\t\t{ \r\n\t\t\t\"criterias\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"conditionList\": [\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\": \"FirstName\",\r\n\t\t\t\t\t\t\t\"operator\": \"==\",\r\n\t\t\t\t\t\t\t\"value\": \"SampleName2\"\r\n\t\t\t\t\t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"DOB\",\r\n \t\t\t\"operator\": \"==\",\r\n \t\t\t\"value\": \"2016/06/05\"\r\n \t\t}\r\n \t]\r\n\t\t\t\t}\r\n \t],\r\n \t\"contentVariables\": [\r\n \t\t{\r\n \t\t\t\"name\": \"Variable2\",\r\n \t\t\t\"value\": \"Sample Value2\"\r\n \t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"Variable3\",\r\n \t\t\t\"value\": \"Sample Value3\"\r\n \t\t},\r\n \t\t{\r\n \t\t\t\"name\": \"Variable4\",\r\n \t\t\t\"value\": \"Sample Value4\"\r\n \t\t}\r\n \t]\r\n\t\t}\r\n\t]\r\n}"},"url":"https://{{domain}}/v2/messages/abtest/10/uploadabtestrules/","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","uploadabtestrules",""],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae370adc-f117-388d-c5be-3e9eaf7ad18e"},{"name":"Delete AB Message Content Rule","id":"777beaae-94ab-1cbf-dabc-871b72bc0697","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/rules/{{ruleid}}","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","rules","{{ruleid}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"777beaae-94ab-1cbf-dabc-871b72bc0697"},{"name":"Delete All AB Message Content Rules","id":"66e90aef-73de-7150-2b8d-050a613d5ebb","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/messages/abtest/10/clearallrules","urlObject":{"protocol":"https","path":["v2","messages","abtest","10","clearallrules"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"66e90aef-73de-7150-2b8d-050a613d5ebb"}],"id":"a2873bd2-4454-9172-5daf-ce613c92621b","_postman_id":"a2873bd2-4454-9172-5daf-ce613c92621b","description":""}],"id":"299ee8c1-dc41-83d8-9457-235fb4d99c4d","_postman_id":"299ee8c1-dc41-83d8-9457-235fb4d99c4d","description":""}],"id":"5a8e4273-fb76-e6bc-c4de-e38f50215ad1","_postman_id":"5a8e4273-fb76-e6bc-c4de-e38f50215ad1","description":""},{"name":"Pages","item":[{"name":"Retrieve Page","id":"675ff03d-ade5-780f-11e4-b15d219bb8fb","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/pages/10","urlObject":{"protocol":"https","path":["v2","pages","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"675ff03d-ade5-780f-11e4-b15d219bb8fb"},{"name":"Retrieve Page Collection","id":"f5770ccd-4f04-07c7-dad2-671ded2248b0","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/pages?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","pages"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"f5770ccd-4f04-07c7-dad2-671ded2248b0"},{"name":"Create Page","id":"4879b435-6ea6-67fd-bf33-971ec3c3df77","request":{"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Page\",\r\n \"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n \"type\": \"landingPage\"\r\n}"},"url":"https://{{domain}}/v2/pages","urlObject":{"protocol":"https","path":["v2","pages"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4879b435-6ea6-67fd-bf33-971ec3c3df77"},{"name":"Update Page","id":"0bc53b92-9523-564e-3c35-07aa8abf34cd","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Page\",\r\n \"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\r\n \"type\": \"landingPage\"\r\n}"},"url":"https://{{domain}}/v2/pages/10","urlObject":{"protocol":"https","path":["v2","pages","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0bc53b92-9523-564e-3c35-07aa8abf34cd"},{"name":"Delete Page","id":"5dd0763a-906d-c315-b848-b525fc2e4b3e","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/pages/10","urlObject":{"protocol":"https","path":["v2","pages","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5dd0763a-906d-c315-b848-b525fc2e4b3e"}],"id":"c0164443-2614-7c80-f03a-31c27270630d","_postman_id":"c0164443-2614-7c80-f03a-31c27270630d","description":""},{"name":"Segments","item":[{"name":"Retrieve Segment","id":"85a4e59a-3364-8841-198f-355109c65ccf","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/segments/10","urlObject":{"protocol":"https","path":["v2","segments","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"85a4e59a-3364-8841-198f-355109c65ccf"},{"name":"Retrieve Segment Collection","id":"44de5863-fe1e-23b0-ecdc-d9cf789b09a5","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/segments?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","segments"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"44de5863-fe1e-23b0-ecdc-d9cf789b09a5"},{"name":"Retrieve Segment Details","id":"c5bbaa08-da71-c02e-2e10-cf34d61e8360","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/segments/10/details","urlObject":{"protocol":"https","path":["v2","segments","10","details"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5bbaa08-da71-c02e-2e10-cf34d61e8360"},{"name":"Retrieve Segment Details Collection","id":"fb7f5c5a-7480-f491-5232-9ee5994af2b6","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"url":"https://{{domain}}/v2/segments/details?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","segments","details"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"fb7f5c5a-7480-f491-5232-9ee5994af2b6"},{"name":"Create Segment","id":"d0da5034-2703-1357-9658-b515404f748d","request":{"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Segment\", \r\n \"operator\": \"OR\",\r\n \"conditionGroup\": [\r\n {\r\n \"operator\": \"AND\",\r\n \"conditions\": [\r\n {\r\n \"$type\": \"FieldCondition\",\r\n \"field\": {\r\n \"id\": 1,\r\n \"name\": \"email\",\r\n \"type\": \"Email\"\r\n },\r\n \"value\": \"sampleaddress@testacc1.com\",\r\n \"fieldOperator\": \"Equals\"\r\n }\r\n ]\r\n }\r\n ]\r\n}\r\n"},"url":"https://{{domain}}/v2/segments","urlObject":{"protocol":"https","path":["v2","segments"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0da5034-2703-1357-9658-b515404f748d"},{"name":"Update Segment","id":"ae7426b7-2f01-c7ec-91e0-1a767275ce18","request":{"method":"PUT","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Segment\", \r\n \"operator\": \"OR\",\r\n \"conditionGroup\": [\r\n {\r\n \"operator\": \"AND\",\r\n \"conditions\": [\r\n {\r\n \"$type\": \"FieldCondition\",\r\n \"field\": {\r\n \"id\": 1,\r\n \"name\": \"email\",\r\n \"type\": \"Email\"\r\n },\r\n \"value\": \"sampleaddress@testacc1.com\",\r\n \"fieldOperator\": \"Equals\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"},"url":"https://{{domain}}/v2/segments/10","urlObject":{"protocol":"https","path":["v2","segments","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae7426b7-2f01-c7ec-91e0-1a767275ce18"},{"name":"Delete Segment","id":"ba1de55e-de6d-b406-d595-d66a78c23a25","request":{"method":"DELETE","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/segments/10","urlObject":{"protocol":"https","path":["v2","segments","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba1de55e-de6d-b406-d595-d66a78c23a25"}],"id":"4a946244-9ea8-33fd-9ee8-5609c80a17f2","description":"

Segments are broken down into AND/OR operators to allow for more complex statements. Currently, we only support the operator OR for ConditionGroups and the operator AND for conditions.

Example

\"operator\": \"OR\",\n    \"conditionGroup\": [\n      {\n        \"operator\": \"AND\",\n        \"conditions\": [\n          {\n            // Condition1\n          },\n      {\n            // Condition2\n          }\n        ]\n      },\n    {\n        \"operator\": \"AND\",\n        \"conditions\": [\n          {\n            // Condition3\n          },\n      {\n            // Condition4\n          }\n        ]\n      }\n    ]\n

\n
This example would result in the following statement:\n\"Condition1 AND Condition2\" OR \"Condition3 AND Condition4\"
\n

Conditions

Each condition has a type which indicates the what data objects you will be working with. Each of these types has specific criteria/options to use so please read through the documentation carefully.

Property: $type

FieldCondition
SentBehaviorCondition
BouncedBehaviorCondition
OpenBehaviourCondition
ClickBehaviourCondition
ContactTypeCondition
SourceCondition

FieldCondition

Using field conditions in segments allows you to target contacts using the data stored in fields using different operators. The operators available are dictated by the field type and may require specific value formats.

Property: fieldOperator

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

fieldOperator Value	For Field Types	Value Format
equals	Email, Text, Number, DateTime	Email or Test: String, Number: Integer, DateTime: MM/DD/YYYY
does not equal	Email, Text, Number, DateTime	Email or Test: String, Number: Integer (up to 2 decimal), DateTime: MM/DD/YYYY
is empty	Email, Text, Number, DateTime	Always 'null'
is not empty	Email, Text, Number, DateTime	Always 'null'
begins with	Email,Text	String
contains	Email,Text	String
does not contain	Email,Text	String
is greater than	Number	Integer (up to 2 decimal)
is greater than or equal to	Number	Integer (up to 2 decimal)
is less than	Number	Integer (up to 2 decimal)
is less than or equal to	Number	Integer (up to 2 decimal)
is after	DateTime	MM/DD/YYYY
is after or equal to	DateTime	MM/DD/YYYY
is before	DateTime	MM/DD/YYYY
is before or equal to	DateTime	MM/DD/YYYY
is today	DateTime	Always 'null'
is not today	DateTime	Always 'null'
Deprecated is before this many days ago	DateTime	----
Deprecated is after this many days ago	DateTime	----
Deprecated is before this many days from now	DateTime	----
Deprecated is after this many days from now	DateTime	----
is in	DateTime	quoted, comma seperated values \"YYYY-MM-DDTHH:MM:SS\"
is not in	DateTime	quoted, comma seperated values \"YYYY-MM-DDTHH:MM:SS\"
between	DateTime	\"YYYY-MM-DDTHH:MM:SS\" AND \"YYYY-MM-DDTHH:MM:SS\"
not between	DateTime	\"YYYY-MM-DDTHH:MM:SS\" AND \"YYYY-MM-DDTHH:MM:SS\"

BehaviourCondition

There are 4 different types of Behaviour Conditions: Sent, Bounce, Open and Click. Each of these condition types allows you to target contacts based on their behaviour or actions within all email deployments.

Within each behaviour condition are common properties that can be used to filter the behaviour data that you use to target on.

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

Property	Description
campaignId	Id of the campaign object retrieved from /campaigns
deploymentId	Id of the campaign object retrieved from /deployments
messageId	Id of the campaign object retrieved from /messages
linkID	Id of the campaign object retrieved from /campaigns

Array: dateRange

Sample

\"dateRange\": {\n              \"dateRangeType\": \"Between\",\n              \"dateTimeFrom\": \"2017-06-01T00:00:00\",\n              \"dateTimeTo\": \"2017-06-01T00:00:00\",\n              \"value\": 0,\n              \"period\": 0\n            },\n

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

dateRangeType	dateTimeFrom	dateTimeTo	value	period
Today	Always 'null'	Always 'null'	Always '0'	Always '0'
NotToday	Always 'null'	Always 'null'	Always '0'	Always '0'
InThePast	Always 'null'	Always 'null'	Use whole integer	'Hours', 'Days' or 'Minutes'
After	Use format 'YYYY-MM-DDThh:mm:ss'	Always 'null'	Always '0'	Always '0'
AfterOrEqualTo	Use format 'YYYY-MM-DDThh:mm:ss'	Always 'null'	Always '0'	Always '0'
Before	Use format 'YYYY-MM-DDThh:mm:ss'	Always 'null'	Always '0'	Always '0'
BeforeOrEqualTo	Use format 'YYYY-MM-DDThh:mm:ss'	Always 'null'	Always '0'	Always '0'
Between	Use format 'YYYY-MM-DDThh:mm:ss'	Use format 'YYYY-MM-DDThh:mm:ss'	Always '0'	Always '0'
NotBetween	Use format 'YYYY-MM-DDThh:mm:ss'	Use format 'YYYY-MM-DDThh:mm:ss'	Always '0'	Always '0'

SentBehaviorCondition

Property: sentBehaviorConditionType

Values

Sent
NotSent

BouncedBehaviorCondition

Property: bouncedBehaviorConditionType

Values

Bounced
DidNotBounced

Property: bouncedCategoryType

Values

Hard
Soft
Technical
Complaint

OpensBehaviorCondition

Property: opensBehaviorConditionType

Values

Opened
DidNotOpen
OpenRate

Property: openRate

This should only be used when 'OpenRate' value is used for openBehaviorConditionType property

Sample

\"openRate\": {\n              \"openClickRateValueType\": \"OpenClicks\",\n              \"openClickRateValue\": 7,\n              \"openClickRateOperator\": \"EqualTo\"\n            }\n

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

Property	Values
openClickRateValueType	'OpenClicks' or 'Percent'
openClickRateValue	Use whole integer
openClickRateOperator	EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo

ClicksBehaviorCondition

Property: clicksBehaviorConditionType

Values

Clicked
DidNotClick
ClickRate

Property: clickRate

This should only be used when 'ClickRate' value is used for clickBehaviorConditionType property

Sample

\"clickRate\": {\n              \"openClickRateValueType\": \"OpenClicks\",\n              \"openClickRateValue\": 7,\n              \"openClickRateOperator\": \"EqualTo\"\n            }\n

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

Property	Values
openClickRateValueType	'OpenClicks' or 'Percent'
openClickRateValue	Use whole integer
openClickRateOperator	EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo, LessThan, LessThanOrEqualTo

SubscriptionCondition

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

Property	Values
subscriptionId	Whole integer
permission	Subscribe, Double Opt-In, Express, Implied, Implied-trans, Implied-2yr, Implied-6mo, Unsubscribed, Unassigned
value	Always null
fieldOperator	Equals, Does not equal

ContactTypeCondition

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

Property	Values
type	Normal, Seed, StakeHolder, TestAccount
value	Always null
fieldOperator	Equals, Does not equal

SourceCondition

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

Property	Values	Description
sourceId	Whole integer	Id of /sources
source	Array	Two properties: sourceTypeId and sourceTaskId
value	Always null
fieldOperator	Equals, Does not equal

Array: source

\"source\": {\n              \"sourceTypeId\": 1,\n              \"sourceTaskId\": 1\n            }\n

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

Property	Values
sourceTypeId	1: Add Person, 2: List Upload, 3: Web Form, 4: FTP Import, 6: API List Upload
sourceTaskId	Used for FTP Import type only. ID of FTP Import Task

","event":[{"listen":"prerequest","script":{"id":"b08d4cab-c0a7-40a0-8524-b59ef702e213","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"75c601cc-cabd-4f11-82c7-cc7969b0cce0","type":"text/javascript","exec":[""]}}],"_postman_id":"4a946244-9ea8-33fd-9ee8-5609c80a17f2"},{"name":"Sources","item":[{"name":"Retrieve Source Details","id":"bd80f7a8-116f-a719-9d36-8ef244d8e40b","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/sources/10","urlObject":{"protocol":"https","path":["v2","sources","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd80f7a8-116f-a719-9d36-8ef244d8e40b"},{"name":"Retrieve Source Collection","id":"1057c2b2-3ec8-0e84-ab58-f72b298236cd","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/sources?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","sources"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"1057c2b2-3ec8-0e84-ab58-f72b298236cd"}],"id":"599092f3-3c5c-4871-6916-f41667e808e3","_postman_id":"599092f3-3c5c-4871-6916-f41667e808e3","description":""},{"name":"Subscriptions","item":[{"name":"Retrieve Subscription Details","id":"f0844b01-22c4-be6c-f360-9eec76d3aa2f","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/subscriptions/10","urlObject":{"protocol":"https","path":["v2","subscriptions","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0844b01-22c4-be6c-f360-9eec76d3aa2f"},{"name":"Retrieve Subscription Collection","id":"49f23834-575c-4a5f-76d3-f978579d15a5","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/subscriptions?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","subscriptions"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"49f23834-575c-4a5f-76d3-f978579d15a5"},{"name":"Update Subscription","id":"b020530e-1ec3-cca8-d7c6-69b69780b24c","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"General\"\n}"},"url":"https://{{domain}}/v2/subscriptions/10","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","subscriptions","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"16726701-9970-6b3b-eaf8-0cf4a05ccddb","name":"UpdateSubscription","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"General\"\n}"},"url":"https://{{domain}}/v2/subscriptions/10"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache,no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"327","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 08 Jun 2017 15:56:33 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":"495","body":"{\n \"data\": {\n \"id\": 1,\n \"name\": \"General\",\n \"subscribed\": 116244,\n \"unsubscribed\": 36\n },\n \"links\": [\n {\n \"self\": \"https://api.teksideconnect.com/v2/subscriptions/1\"\n },\n {\n \"subscriptions\": \"https://api.teksideconnect.com/v2/subscriptions/1\"\n }\n ]\n}"}],"_postman_id":"b020530e-1ec3-cca8-d7c6-69b69780b24c"},{"name":"Retrieve Subscription Permission Count","id":"4310410d-0c33-9812-77b0-3712d5aa3f4b","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/subscriptions/10/{{permission_level}}","description":"

permission_level options

subscribe
unsubscribed
express
implied (Non-CASL)
implied-2yr
implied-6mo
implied-trans

\n","urlObject":{"protocol":"https","path":["v2","subscriptions","10","{{permission_level}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4310410d-0c33-9812-77b0-3712d5aa3f4b"}],"id":"4c4c181c-1777-a8d6-111e-026af8daf9c4","_postman_id":"4c4c181c-1777-a8d6-111e-026af8daf9c4","description":""},{"name":"Templates","item":[{"name":"Retrieve Template Details","id":"905a3da0-311a-4db1-e923-b04845deba01","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/templates/10","urlObject":{"protocol":"https","path":["v2","templates","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"905a3da0-311a-4db1-e923-b04845deba01"},{"name":"Retrieve Template Collection","id":"fec9fcdd-63db-405e-aafd-83890665e6ba","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"url":"https://{{domain}}/v2/templates?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","templates"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"fec9fcdd-63db-405e-aafd-83890665e6ba"},{"name":"Create Template","id":"2649f28f-fad3-68c2-bd69-da4e4a107c9c","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample Template\",\n \"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\n \"enabled\": true\n}"},"url":"https://{{domain}}/v2/templates","urlObject":{"protocol":"https","path":["v2","templates"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2649f28f-fad3-68c2-bd69-da4e4a107c9c"},{"name":"Update Template","id":"4c0ea384-6606-8d2c-60d1-b4ab18ebbc78","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sample Template\",\n \"html\": \"<\\/head>Sample HTML Document<\\/body><\\/html>\",\n \"enabled\": true\n}"},"url":"https://{{domain}}/v2/templates/10","urlObject":{"protocol":"https","path":["v2","templates","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c0ea384-6606-8d2c-60d1-b4ab18ebbc78"}],"id":"94772ea4-acb2-4650-ed55-d1813685100f","_postman_id":"94772ea4-acb2-4650-ed55-d1813685100f","description":""},{"name":"Triggers","item":[{"name":"Retrieve Trigger Collection","id":"effe92d3-5033-f6e9-76f2-20a8c963fad5","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/triggers?page=0&limit=25","urlObject":{"protocol":"https","path":["v2","triggers"],"host":["{{domain}}"],"query":[{"description":{"content":"

The page number of the results to return. 0 based index. Default:0. Type: Number

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

The maximum number of results to return per page. Maximum 25. Default: 20. Type: Number

\n","type":"text/plain"},"key":"limit","value":"25"}],"variable":[]}},"response":[{"id":"3e32a0c2-cc5a-4753-9fa9-1c2496e0e987","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Demo_Trigger_01\",\r\n \"messageId\": 46,\r\n \"subscriptionId\": 1,\r\n \"isTestTrigger\" : false\r\n}\r\n"},"url":{"raw":"https://{{domain}}/v2/triggers?page=0&limit=25","protocol":"https","host":["{{domain}}"],"path":["v2","triggers"],"query":[{"key":"page","value":"0","description":"The page number of the results to return. __0 based index__. **Default:**`0`. **Type:** Number"},{"key":"limit","value":"25","description":"The maximum number of results to return per page. __Maximum 25__. **Default:** `20`. **Type:** Number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"857","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 18 Sep 2018 20:15:17 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"triggerId\": 1,\n \"name\": \"Demo_Trigger_01\",\n \"messageId\": 41,\n \"subscriptionId\": 1,\n \"isTestTrigger\": false,\n \"isEnabled\": true,\n \"isTransactional\": true,\n \"createdDateTime\": \"2017-11-22T16:05:57.127Z\"\n },\n {\n \"triggerId\": 2,\n \"name\": \"Demo_Trigger_02\",\n \"messageId\": 41,\n \"subscriptionId\": 1,\n \"isTestTrigger\": false,\n \"isEnabled\": true,\n \"isTransactional\": true,\n \"createdDateTime\": \"2018-09-18T16:13:05.56Z\"\n }\n ],\n \"count\": 2,\n \"links\": [\n {\n \"self\": \"https://api.teksideconnect.com/v2/triggers?page=0&limit=25\"\n },\n {\n \"trigger:1\": \"https://api.teksideconnect.com/v2/triggers/1\"\n },\n {\n \"trigger:2\": \"https://api.teksideconnect.com/v2/triggers/2\"\n }\n ]\n}"}],"_postman_id":"effe92d3-5033-f6e9-76f2-20a8c963fad5"},{"name":"Retrieve Trigger Details","id":"14746ece-3cc2-a4dd-80ae-7c4646eb34d8","request":{"method":"GET","header":[{"key":"Token","value":"{{token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain}}/v2/triggers/10","urlObject":{"protocol":"https","path":["v2","triggers","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"0f0366d5-72b4-42f9-a99f-767d2f866dea","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Token","value":"{{token}}","disabled":false}],"body":{"mode":"raw","raw":"{\r\n\"contact\": \r\n\t{\r\n\t\t\"fields\": [\r\n\t\t\t{\r\n\t\t\t\t\"field\": \r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"id\": 1,\r\n\t\t\t\t\t\t\"name\": \"Email\",\r\n\t\t\t\t\t\t\"type\": \"Email\",\r\n\t\t\t\t\t\t\"required\": true\r\n\t\t\t\t\t}, \r\n\t\t\t\t\"value\": \"andrew+trigtest@inboxmarketer.com\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"field\": \r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"id\": 2,\r\n\t\t\t\t\t\t\"name\": \"FirstName\",\r\n\t\t\t\t\t\t\"type\": \"Text\",\r\n\t\t\t\t\t\t\"required\": false\r\n\t\t\t\t\t}, \r\n\t\t\t\t\"value\": \"test\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"field\": \r\n\t\t\t\t\t{\r\n\t\t\t\t\t\t\"id\": 3,\r\n\t\t\t\t\t\t\"name\": \"LastName\",\r\n\t\t\t\t\t\t\"type\": \"Text\",\r\n\t\t\t\t\t\t\"required\": false\r\n\t\t\t\t\t}, \r\n\t\t\t\t\"value\": \"test\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"field\":\r\n\t\t\t\t\t{\r\n\t\t\t\t \"id\": 28,\r\n\t\t\t\t \"name\": \"Location1\",\r\n\t\t\t\t \"type\": \"Text\",\r\n\t\t\t\t \"required\": false\r\n\t\t\t\t\t},\r\n\t\t\t\t\"value\": \"Vancouver\"\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\"Content\": {\r\n\t\"DynamicVariables\":\r\n\t\t[\r\n\t\t {\"name\":\"variable1\", \"value\": \"This is variable 1\"},\r\n\t\t {\"name\":\"variable2\", \"value\": \"This is variable 1\"}\r\n\t\t],\r\n\t\"dynamicContent\": {\r\n\t\t\"dynamicBlocks\":\r\n\t\t\t[{\r\n\t\t\t\t\"blockname\":\"ForEach\",\r\n\t\t\t\t\"data\":[\r\n\t\t\t\t\t[\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\":\"header\",\r\n\t\t\t\t\t\t\t\"value\":\"Blueberry Muffins\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\":\"image\",\r\n\t\t\t\t\t\t\t\"value\":\"http://placehold.it/60x60?text=Blueberry+Muffins\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\":\"button\",\r\n\t\t\t\t\t\t\t\"value\":\"Blueberry Muffins<\\/a>\"\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\t],\r\n\t\t\t\t\t[\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\":\"header\",\r\n\t\t\t\t\t\t\t\"value\":\"Apple Pie\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\":\"image\",\r\n\t\t\t\t\t\t\t\"value\":\"http://placehold.it/60x60?text=Apple+Pie\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"name\":\"button\",\r\n\t\t\t\t\t\t\t\"value\":\"Apple Pie<\\/a>\"\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\t]\r\n\t\t\t\t]\r\n\t\t\t}]\r\n\t}\r\n}\r\n}"},"url":"https://{{domain}}/v2/triggers/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"535","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 18 Sep 2018 20:16:06 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"triggerId\": 2,\n \"name\": \"Demo_Trigger_01\",\n \"messageId\": 41,\n \"subscriptionId\": 1,\n \"isTestTrigger\": false,\n \"isEnabled\": true,\n \"isTransactional\": true,\n \"createdDateTime\": \"2018-09-18T16:13:05.56Z\"\n },\n \"links\": [\n {\n \"self\": \"https://api.teksideconnect.com/v2/triggers/2\"\n },\n {\n \"message\": \"https://api.teksideconnect.com/v2/messages/41\"\n },\n {\n \"subscription\": \"https://api.teksideconnect.com/v2/subscriptions/1\"\n }\n ]\n}"}],"_postman_id":"14746ece-3cc2-a4dd-80ae-7c4646eb34d8"},{"name":"Create Trigger","id":"693de307-99c2-19be-eedc-4e528edd2981","request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Demo_Trigger_01\",\r\n \"messageId\": 41,\r\n \"transactional\": true,\r\n \"subscriptionId\": 1,\r\n \"isTestTrigger\" : false\r\n}\r\n"},"url":"https://{{domain}}/v2/triggers","description":"

This endpoint creates the deployment you will then execute by providing a contact and/or additional content. The following settings can be defined:

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

Property	Required	Default	Description
`name`	Yes	n/a	The friendly name for your trigger. This will be used in the deployment name as well.
`messageId`	Yes	n/a	The id of the message you would like to send to each recipient. Note Must be type: `trigger`.
`transactional`	No	`true`	A boolean to identify if contacts should be suppressed if unsubscribed/unassigned (i.e. `false`) or not (i.e. `true`).
`subscriptionId`	No	`null`	The id of the subscription that will be used for any subscription references in the message or to suppress unsubscribed/unassigned contacts (if `transactional` is `false`).
`isTestTrigger`	No	`false`	Flags trigger as type `test` which will add \"Test -\" to the subject line when sending and will not add contact data to the DataMart.

","urlObject":{"protocol":"https","path":["v2","triggers"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"6a4ef677-2c34-4a6f-8e3d-86f44d5b7db5","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Token","value":"{{token}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Demo_Trigger_01\",\r\n \"messageId\": 41,\r\n \"transactional\": true,\r\n \"subscriptionId\": 1,\r\n \"isTestTrigger\" : false\r\n}\r\n"},"url":"https://{{domain}}/v2/triggers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"716","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 18 Sep 2018 20:13:10 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"triggerId\": 2,\n \"name\": \"Demo_Trigger_01\",\n \"messageId\": 41,\n \"subscriptionId\": 1,\n \"isTestTrigger\": false,\n \"isEnabled\": true,\n \"isTransactional\": true,\n \"createdDateTime\": \"2018-09-18T16:13:05.56Z\"\n },\n \"links\": [\n {\n \"self\": \"https://api.teksideconnect.com/v2/triggers\"\n },\n {\n \"message\": \"https://api.teksideconnect.com/v2/messages/41\"\n },\n {\n \"trigger\": \"https://api.teksideconnect.com/v2/triggers/2\"\n },\n {\n \"triggerexecute\": \"https://api.teksideconnect.com/v2/triggers/execute/2\"\n },\n {\n \"subscription\": \"https://api.teksideconnect.com/v2/subscriptions/1\"\n }\n ]\n}"}],"_postman_id":"693de307-99c2-19be-eedc-4e528edd2981"},{"name":"Update Trigger","id":"5504159a-b143-a54b-9cc2-1aa8fc82ca0e","request":{"method":"PUT","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Demo_Trigger_01\",\r\n \"messageId\": 41,\r\n \"transactional\": true,\r\n \"subscriptionId\": 1\r\n}\r\n"},"url":"https://{{domain}}/v2/triggers/10","urlObject":{"protocol":"https","path":["v2","triggers","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"09465218-da7b-4ab3-b12c-5ed2df612397","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Token","value":"{{token}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Demo_Trigger_01\",\r\n \"messageId\": 41,\r\n \"transactional\": true,\r\n \"subscriptionId\": 1\r\n}\r\n"},"url":"https://{{domain}}/v2/triggers/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"718","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 18 Sep 2018 20:14:37 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"triggerId\": 2,\n \"name\": \"Demo_Trigger_01\",\n \"messageId\": 41,\n \"subscriptionId\": 1,\n \"isTestTrigger\": false,\n \"isEnabled\": true,\n \"isTransactional\": true,\n \"createdDateTime\": \"2018-09-18T16:13:05.56Z\"\n },\n \"links\": [\n {\n \"self\": \"https://api.teksideconnect.com/v2/triggers/2\"\n },\n {\n \"message\": \"https://api.teksideconnect.com/v2/messages/41\"\n },\n {\n \"trigger\": \"https://api.teksideconnect.com/v2/triggers/2\"\n },\n {\n \"triggerexecute\": \"https://api.teksideconnect.com/v2/triggers/execute/2\"\n },\n {\n \"subscription\": \"https://api.teksideconnect.com/v2/subscriptions/1\"\n }\n ]\n}"}],"_postman_id":"5504159a-b143-a54b-9cc2-1aa8fc82ca0e"},{"name":"Execute Trigger to Single Contact","id":"f68970c8-6138-313f-cbc4-455859f7842a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"contact\": \t{\r\n\t\t\"fields\": [\r\n\t\t\t{\r\n\t\t\t\t\"field\": {\r\n\t\t\t\t\t\t\"id\": 1,\r\n\t\t\t\t\t\t\"name\": \"Email\",\r\n\t\t\t\t\t\t\"type\": \"Email\",\r\n\t\t\t\t\t\t\"required\": true\r\n\t\t\t\t}, \r\n\t\t\t\t\"value\": \"sampleemail@testacc1.com\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"field\": {\r\n\t\t\t\t\t\t\"id\": 2,\r\n\t\t\t\t\t\t\"name\": \"FirstName\",\r\n\t\t\t\t\t\t\"type\": \"Text\",\r\n\t\t\t\t\t\t\"required\": false\r\n\t\t\t\t\t}, \r\n\t\t\t\t\"value\": \"Sample\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"field\": {\r\n\t\t\t\t\t\"id\": 3,\r\n\t\t\t\t\t\"name\": \"LastName\",\r\n\t\t\t\t\t\"type\": \"Text\",\r\n\t\t\t\t\t\"required\": false\r\n\t\t\t\t}, \r\n\t\t\t\t\"value\": \"Email\"\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t\"content\": {\r\n\t\t\"dynamicVariables\": [\r\n\t\t\t{\r\n\t\t\t\t\"name\":\"variable1\", \r\n\t\t\t\t\"value\": \"This is variable 1\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"name\":\"variable2\", \r\n\t\t\t\t\"value\": \"This is variable 1\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"dynamicContent\": {\r\n\t\t\t\"dynamicBlocks\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"blockname\":\"ForEach\",\r\n\t\t\t\t\t\"data\": [\r\n\t\t\t\t\t\t[\r\n\t\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\t\"name\":\"header\",\r\n\t\t\t\t\t\t\t\t\"value\":\"Blueberry Muffins\"\r\n\t\t\t\t\t\t\t},\r\n\t\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\t\"name\":\"image\",\r\n\t\t\t\t\t\t\t\t\"value\":\"http://placehold.it/60x60?text=Blueberry+Muffins\"\r\n\t\t\t\t\t\t\t},\r\n\t\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\t\"name\":\"button\",\r\n\t\t\t\t\t\t\t\t\"value\":\"Blueberry Muffins<\\/a>\"\r\n\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t],\r\n\t\t\t\t\t\t[\r\n\t\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\t\"name\":\"header\",\r\n\t\t\t\t\t\t\t\t\"value\":\"Apple Pie\"\r\n\t\t\t\t\t\t\t},\r\n\t\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\t\"name\":\"image\",\r\n\t\t\t\t\t\t\t\t\"value\":\"http://placehold.it/60x60?text=Apple+Pie\"\r\n\t\t\t\t\t\t\t},\r\n\t\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\t\"name\":\"button\",\r\n\t\t\t\t\t\t\t\t\"value\":\"Apple Pie<\\/a>\"\r\n\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t]\r\n\t\t\t\t\t]\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t}\r\n}"},"url":"https://{{domain}}/v2/triggers/execute/3","description":"

This endpoint sends a request to the trigger to send using the data provided. Within the request, there are two main sections: Contact and Content. The contact section is where you will define any contact data you would like to have inserted in the Datamart with the contact as well as used within the template. The content section is used to define data you would like to insert into the message but not store with the contact.

Defining subscription information:

Optionally, you can add the subscription parameter to the contact parameter to define subscription information. This is paticularily helpful if you are triggering a message off of an external web form.

  \"subscriptionPermissions\": [\n    {\n      \"id\": 1,\n      \"name\": \"General\",\n      \"permission\": \"Express\",\n      \"permissionCaptureDateTime\": \"2100-01-01T23:59:59Z\"\n    }\n  ],\n  \"isPermissionDateCompareDisable\": \"false\"\n

This endpoint provides users with the ability to create a re-usable deployment that can be executed repeatedly to send to one or multiple contacts.

\n","event":[{"listen":"prerequest","script":{"id":"ac813c32-8d38-4d88-bf0c-3865737947a9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"23abb810-8d78-4211-96d7-f6be87bfbe18","type":"text/javascript","exec":[""]}}],"_postman_id":"adf60824-7851-befc-b987-0b7174446142"},{"name":"Webforms","item":[{"name":"Retrieve Webform Collection","id":"fae5b1c0-1577-90cf-88f3-8a11b297c77c","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/webforms?page=0&limit=25","description":"

Parameters

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

Parameter	Description	Default	Type
limit	The maximum number of results to return per page. Maximum 25.	`20`	Number
page	The page number of the results to return. 0 based index.	`0`	Number

","urlObject":{"protocol":"https","path":["v2","webforms"],"host":["{{domain}}"],"query":[{"key":"page","value":"0"},{"key":"limit","value":"25"}],"variable":[]}},"response":[],"_postman_id":"fae5b1c0-1577-90cf-88f3-8a11b297c77c"},{"name":"Retrieve Webform Details","id":"12f32723-a08f-13a8-c916-075ddb573194","request":{"method":"GET","header":[{"key":"token","value":"{{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{domain}}/v2/webforms/10","description":"

https://api.teksideconnect.com/v2/webForms/1

\n","urlObject":{"protocol":"https","path":["v2","webforms","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12f32723-a08f-13a8-c916-075ddb573194"},{"name":"Create Webform","id":"cfdb8024-fe49-e6f5-7af9-263594ba4980","request":{"method":"POST","header":[{"key":"token","value":"{{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Webform Name\",\r\n \"fields\": [\r\n {\r\n \"id\": 1,\r\n \"label\": \"Email\",\r\n \"inputControlType\": \"SimpleText\",\r\n \"isRequired\": true,\r\n \"inputControlData\": []\r\n },\r\n {\r\n \"id\": 2,\r\n \"label\": \"Province\",\r\n \"inputControlType\": \"Dropdown\",\r\n \"isRequired\": false,\r\n \"inputControlData\": [\r\n {\r\n \"displayText\": \"Ontario\",\r\n \"value\": \"ON\",\r\n \"isDefault\": true\r\n },\r\n {\r\n \"displayText\": \"Quebec\",\r\n \"value\": \"QC\",\r\n \"isDefault\": false\r\n }\r\n ]\r\n }\r\n ],\r\n \"subscriptions\": [\r\n {\r\n \"id\": 1,\r\n \"submitAction\": \"optin\",\r\n \"optInText\": \"Check to receive future communications from Company Y\",\r\n \"permissionLevel\": \"Express\"\r\n }\r\n ],\r\n \"page\": 1,\r\n \"submitButtonText\": \"Submit\",\r\n \"autoresponderMessage\": 265\r\n }"},"url":"https://{{domain}}/v2/webforms","description":"

https://api.teksideconnect.com/v2/webForms?page=0&limit=20

\n","urlObject":{"protocol":"https","path":["v2","webforms"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cfdb8024-fe49-e6f5-7af9-263594ba4980"},{"name":"Update Webform","id":"9c9688ea-68ad-7729-65bf-ad64622fdab1","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"token","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Sample Webform Name\",\r\n \"fields\": [\r\n {\r\n \"id\": 1,\r\n \"label\": \"Email\",\r\n \"inputControlType\": \"SimpleText\",\r\n \"isRequired\": true,\r\n \"inputControlData\": []\r\n },\r\n {\r\n \"id\": 2,\r\n \"label\": \"Province\",\r\n \"inputControlType\": \"Dropdown\",\r\n \"isRequired\": false,\r\n \"inputControlData\": [\r\n {\r\n \"displayText\": \"Ontario\",\r\n \"value\": \"ON\",\r\n \"isDefault\": true\r\n },\r\n {\r\n \"displayText\": \"Quebec\",\r\n \"value\": \"QC\",\r\n \"isDefault\": false\r\n }\r\n ]\r\n }\r\n ],\r\n \"subscriptions\": [\r\n {\r\n \"id\": 1,\r\n \"submitAction\": \"optin\",\r\n \"optInText\": \"Check to receive future communications from Company Y\",\r\n \"permissionLevel\": \"Express\"\r\n }\r\n ],\r\n \"page\": 1,\r\n \"submitButtonText\": \"Submit\",\r\n \"autoresponderMessage\": 265\r\n }"},"url":"https://{{domain}}/v2/webforms/10","description":"

https://api.teksideconnect.com/v2/webForms/8

\n","urlObject":{"protocol":"https","path":["v2","webforms","10"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c9688ea-68ad-7729-65bf-ad64622fdab1"}],"id":"e174c886-0bff-b816-f184-bc7dacf87e21","_postman_id":"e174c886-0bff-b816-f184-bc7dacf87e21","description":""}],"event":[{"listen":"prerequest","script":{"id":"0655ac75-02d2-48f7-b908-895871f79dc8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7bba045e-3197-4f64-b429-c5d9a0071b44","type":"text/javascript","exec":[""]}}],"variable":[{"key":"id","value":"10"}]}