{"_id":"58466cad4469290f007f74e8","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"},"parentDoc":null,"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"},"project":"55843604fd8d910d007b9502","user":"57ab6eabb5e8742000e17e7d","__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-06T07:45:49.566Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"language":"curl","code":"curl 'https://yourdatacenterid.qualtrics.com/API/v3/directories/POOL_012345678901234/transactionbatches' \\\n-X POST \\\n-H 'X-API-TOKEN: yourtokenhere' \\\n-H 'Content-Type: application/json' \\\n-d '\n    {\n      \"transactionIds\": [\n        \"CTR_012345678901234\",\n        \"CTR_zxcv8901234th68\",\n        ...\n      ],\n      \"creationDate\": \"2016-10-27 10:10:19\"\n    }\n   '"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"id\": \"BT_012345678901234\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"623c60ba-6df1-4949-8d91-1ba43c53c445\"\n  }  \n}","language":"json","status":200}]},"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":"5846f27be79def0f002810c0","ref":"","in":"body","required":false,"desc":"A JSON array that contains the transactions to include in the batch","default":"","type":"array_string","name":"transactionIds"},{"_id":"5846f27be79def0f002810bf","ref":"","in":"body","required":false,"desc":"The date formatted as **yyyy-MM-dd HH:mm:ss**. Please see the warning below regarding this parameter.","default":"(current UTC time if not specified)","type":"string","name":"creationDate"}],"url":"/v:version/directories/:directoryId/transactionbatches"},"isReference":false,"order":15,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Currently `creationDate` is interpreted as 24-hour based UTC time. Specifying **AM** or **PM** or any other date-time format will return an error. Note that timezones are not supported.\",\n  \"title\": \"creationDate format\"\n}\n[/block]","excerpt":"Create a batch, a collection of transactions","slug":"create-transaction-batch","type":"endpoint","title":"Create Transaction Batch"}

postCreate Transaction Batch

Create a batch, a collection of transactions

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

transactionIds:
array of strings
A JSON array that contains the transactions to include in the batch
creationDate:
string(current UTC time if not specified)
The date formatted as **yyyy-MM-dd HH:mm:ss**. Please see the warning below regarding this parameter.

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "body": "Currently `creationDate` is interpreted as 24-hour based UTC time. Specifying **AM** or **PM** or any other date-time format will return an error. Note that timezones are not supported.", "title": "creationDate format" } [/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 }}