{"_id":"58461ddf8abd480f009125bd","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":46,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"55d3c6a4fe37111900e536f9","__v":0,"version":"558444ceafccfd0d00fcb2bb","pages":[],"project":"55843604fd8d910d007b9502","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T23:58:28.218Z","from_sync":false,"order":23,"slug":"directory","title":"Target Audience"},"user":"57ab6eabb5e8742000e17e7d","__v":7,"parentDoc":null,"project":"55843604fd8d910d007b9502","updates":["58e6b0cb4dae652300f9490f"],"next":{"pages":[],"description":""},"createdAt":"2016-12-06T02:09:35.685Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl 'https://yourdatacenterid.qualtrics.com/API/v3/directories/POOL_012345678901234/transactions' \\\n-X POST \\\n-H 'X-API-TOKEN: yourtokenhere' \\\n-H 'Content-Type: application/json' \\\n-d '\n    {\n      \"0\": {\n        \"contactId\": \"CID_012345678901234\", \n        \"mailingListId\": \"CG_012345678901234\", \n        \"transactionDate\": \"2016-12-05 15:45:04\", \n        \"data\": {\n          \"type\": \"StoreVisit\", \n          \"currency\": \"USD\", \n          \"anyField\": \"anyValue\"\n        }\n      },\n      \"234\": {\n        \"contactId\": \"CID_012345678901AAA\", \n        \"mailingListId\": \"CG_BBB345678901234\", \n        \"transactionDate\": \"2016-12-01 23:01:15\", \n        \"data\": {\n          \"type\": \"OnlinePurchase\", \n          \"currency\": \"GBP\", \n          \"anyField\": \"anyValue\"\n        }\n      }\n    }\n   '","language":"curl"},{"language":"curl","name":"cURL (Postman)","code":"curl -X POST -H 'X-API-TOKEN: yourtokenhere' -H 'Content-Type: application/json' -d '\n    {\n      \"0\": {\n        \"contactId\": \"CID_012345678901234\", \n        \"mailingListId\": \"CG_012345678901234\", \n        \"transactionDate\": \"2016-12-05 15:45:04\", \n        \"data\": {\n          \"type\": \"StoreVisit\", \n          \"currency\": \"USD\", \n          \"anyField\": \"anyValue\"\n        }\n      },\n      \"234\": {\n        \"contactId\": \"CID_012345678901AAA\", \n        \"mailingListId\": \"CG_BBB345678901234\", \n        \"transactionDate\": \"2016-12-01 23:01:15\", \n        \"data\": {\n          \"type\": \"OnlinePurchase\", \n          \"currency\": \"GBP\", \n          \"anyField\": \"anyValue\"\n        }\n      }\n    }\n   ' \"https://yourdatacenterid.qualtrics.com/API/v3/directories/POOL_012345678901234/transactions\""}]},"method":"post","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"result\": {\n    \"createdTransactions\": {\n      \"0\": {\n        \"id\": \"CTR_012345678901234\"\n      }\n    },\n    \"unprocessedTransactions\": {\n      \"234\": {\n        \"error\": \"ContactNotInMailingList\",\n        \"errorMessage\": ...\n      }\n    }\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"623c60ba-6df1-4949-8d91-1ba43c53c445\"\n  }  \n}"}]},"settings":"","auth":"required","params":[{"_id":"584626a4cdb4f10f001415f6","ref":"","in":"path","required":true,"desc":"The directory ID, also known as a pool ID","default":"","type":"string","name":"directoryId"},{"_id":"584665f84469290f007f74da","ref":"","in":"body","required":true,"desc":"The request body consists of one or more (limit of 100) **keyedTransaction** objects (please refer to the documentation below to understand how this object is constructed)","default":"","type":"object","name":"keyedTransaction"}],"url":"/v:version/directories/:directoryId/transactions"},"isReference":false,"order":8,"body":"We recommend that you familiarize yourself with [BNF](https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form) before proceeding further with the information below.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Request body definition\",\n  \"body\": \"{\\n<keyedTransaction>,\\n<keyedTransaction>,\\n<keyedTransaction>,\\n...\\n}\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"keyedTransaction definition\",\n  \"body\": \"<keyedTransaction> ::= <key> \\\":\\\" <transaction>\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"transaction definition\",\n  \"body\": \"<transaction> ::= {\\n&nbsp;&nbsp;&nbsp;<contactId> ::= <string>,\\n&nbsp;&nbsp;&nbsp;<mailingListId> ::= <string>,\\n&nbsp;&nbsp;&nbsp;<transactionDate> ::= <string>,\\n&nbsp;&nbsp;&nbsp;<data>\\n}\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"data definition\",\n  \"body\": \"<data> ::= {\\n&nbsp;&nbsp;&nbsp;<property>,\\n&nbsp;&nbsp;&nbsp;<property>,\\n&nbsp;&nbsp;&nbsp;<property>,\\n&nbsp;&nbsp;&nbsp;...\\n}\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Miscellaneous definitions\",\n  \"body\": \"<key> ::= <string>\\n\\n<property> ::= <name> \\\":\\\" <value>\\n\\n<name> ::= <string>\\n\\n<value> ::= <string>\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Currently *transactionDate* is interpreted as 24-hour based UTC time. Specifying **AM** or **PM** or any other date-time format will return an error.\",\n  \"title\": \"transactionDate format\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"transactionDate default value\",\n  \"body\": \"If *transactionDate* is not specified, it will default to the current UTC time.\"\n}\n[/block]","excerpt":"Create transactions for multiple contacts across multiple mailing lists with customized data","slug":"create-contact-transactions","type":"endpoint","title":"Create Contact Transactions"}

postCreate Contact Transactions

Create transactions for multiple contacts across multiple mailing lists with customized data

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

directoryId:
required
string
The directory ID, also known as a pool ID

Body Params

keyedTransaction:
required
object
The request body consists of one or more (limit of 100) **keyedTransaction** objects (please refer to the documentation below to understand how this object is constructed)

Examples


Result Format


Documentation

We recommend that you familiarize yourself with [BNF](https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form) before proceeding further with the information below. [block:callout] { "type": "info", "title": "Request body definition", "body": "{\n<keyedTransaction>,\n<keyedTransaction>,\n<keyedTransaction>,\n...\n}" } [/block] [block:callout] { "type": "info", "title": "keyedTransaction definition", "body": "<keyedTransaction> ::= <key> \":\" <transaction>" } [/block] [block:callout] { "type": "info", "title": "transaction definition", "body": "<transaction> ::= {\n&nbsp;&nbsp;&nbsp;<contactId> ::= <string>,\n&nbsp;&nbsp;&nbsp;<mailingListId> ::= <string>,\n&nbsp;&nbsp;&nbsp;<transactionDate> ::= <string>,\n&nbsp;&nbsp;&nbsp;<data>\n}" } [/block] [block:callout] { "type": "info", "title": "data definition", "body": "<data> ::= {\n&nbsp;&nbsp;&nbsp;<property>,\n&nbsp;&nbsp;&nbsp;<property>,\n&nbsp;&nbsp;&nbsp;<property>,\n&nbsp;&nbsp;&nbsp;...\n}" } [/block] [block:callout] { "type": "info", "title": "Miscellaneous definitions", "body": "<key> ::= <string>\n\n<property> ::= <name> \":\" <value>\n\n<name> ::= <string>\n\n<value> ::= <string>" } [/block] [block:callout] { "type": "warning", "body": "Currently *transactionDate* is interpreted as 24-hour based UTC time. Specifying **AM** or **PM** or any other date-time format will return an error.", "title": "transactionDate format" } [/block] [block:callout] { "type": "info", "title": "transactionDate default value", "body": "If *transactionDate* is not specified, it will default to the current UTC time." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}