{"_id":"560e8c31c4e4ae0d00b42f3e","user":"55dd9841cafe7221002a4c62","__v":2,"editedParams2":true,"version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"project":"55dd9f2e0efd5821000d54d9","category":{"_id":"55f0365c8563861700a33765","version":"55dd9f4dab0e4d210045aae9","__v":10,"pages":["560d337799bb5a0d0044f2ae","560d3c1799bb5a0d0044f2b9","560e8b1fdfdd5a2100e8efd8","560e8c31c4e4ae0d00b42f3e","560e8f5159cb8d0d0015cd21","560e8faccac9dc0d007af836","560e915739fad419002ae1a6","560e9264c4e4ae0d00b42f4a","560e954d39fad419002ae1aa","561fb03b9dc7ce0d00c38c90"],"project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:38:36.012Z","from_sync":false,"order":16,"slug":"transactional-data","title":"Transactional data"},"parentDoc":null,"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-02T13:52:49.038Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"key\": \"P00000001\",\n  \"contactIdentifier\": \"986710407\",\n  \"json\": \"{\\r\\n  \\\"PurchaseDate\\\": \\\"2012-11-19T10:01:21Z\\\",\\r\\n  \\\"TotalExTax\\\": 111.2000000000,\\r\\n  \\\"TotalIncTax\\\": 133.4400000000,\\r\\n  \\\"Product\\\": [\\r\\n    {\\r\\n      \\\"Name\\\": \\\"Long unlined leather gloves\\\",\\r\\n      \\\"Brand\\\": \\\"Dents\\\",\\r\\n      \\\"Department\\\": \\\"Womenswear\\\",\\r\\n      \\\"Category\\\": \\\"Gloves\\\",\\r\\n      \\\"PriceExTax\\\": 111.2000000000,\\r\\n      \\\"ProductID\\\": \\\"24920\\\"\\r\\n    }\\r\\n  ],\\r\\n  \\\"SalesChannel\\\": \\\"Online\\\",\\r\\n  \\\"SalesSubChannel\\\": \\\"myshop.com\\\"\\r\\n}\"\n}"}]},"settings":"","examples":{"codes":[{"code":"var url = \"/v2/contacts/transactional-data/Purchases/P00000001\";\nvar content = :::at:::\"{ json: \"\"{\n  \"\"PurchaseDate\"\": \"\"2012-11-19T10:01:21Z\"\",\n  \"\"TotalExTax\"\": 111.2000000000,\n  \"\"TotalIncTax\"\": 133.4400000000,\n  \"\"Product\"\": [\n    {\n      \"\"Name\"\": \"\"Long unlined leather gloves\"\",\n      \"\"Brand\"\": \"\"Dents\"\",\n      \"\"Department\"\": \"\"Womenswear\"\",\n      \"\"Category\"\": \"\"Gloves\"\",\n      \"\"PriceExTax\"\": 111.2000000000,\n      \"\"ProductID\"\": \"\"24920\"\"\n    }\n  ],\n  \"\"SalesChannel\"\": \"\"Online\"\",\n  \"\"SalesSubChannel\"\": \"\"myshop.com\"\"\n}\"\" }\";\n\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\n\tvar credentials = Encoding.ASCII.GetBytes(\"username:password\");\n\thttpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n\tvar result = httpClient.PostAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n}","language":"csharp","name":""},{"code":"{\n  \"key\": \"P00000001\",\n  \"contactIdentifier\": \"986710407\",\n  \"json\": \"{\\r\\n  \\\"PurchaseDate\\\": \\\"2012-11-19T10:01:21Z\\\",\\r\\n  \\\"TotalExTax\\\": 111.2000000000,\\r\\n  \\\"TotalIncTax\\\": 133.4400000000,\\r\\n  \\\"Product\\\": [\\r\\n    {\\r\\n      \\\"Name\\\": \\\"Long unlined leather gloves\\\",\\r\\n      \\\"Brand\\\": \\\"Dents\\\",\\r\\n      \\\"Department\\\": \\\"Womenswear\\\",\\r\\n      \\\"Category\\\": \\\"Gloves\\\",\\r\\n      \\\"PriceExTax\\\": 111.2000000000,\\r\\n      \\\"ProductID\\\": \\\"24920\\\"\\r\\n    }\\r\\n  ],\\r\\n  \\\"SalesChannel\\\": \\\"Online\\\",\\r\\n  \\\"SalesSubChannel\\\": \\\"myshop.com\\\"\\r\\n}\"\n}","language":"json"},{"code":"$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/contacts/transactional-data/Purchases/P00000001\";\n\n$content = [\n    'json' => json_encode([\n        \"PurchaseDate\" => \"2012-11-19T10:01:21Z\",\n        \"TotalExTax\" => 111.2000000000,\n        \"TotalIncTax\" =>  133.4400000000,\n        \"Product\" => [\n            \"Name\" => \"Long unlined leather gloves\",\n            \"Brand\" => \"Dents\",\n            \"Department\" => \"Womenswear\",\n            \"Category\" => \"Gloves\",\n            \"PriceExTax\" => 111.2000000000,\n            \"ProductID\" => \"24920\"\n        ],\n            \"SalesChannel\" => \"Online\",\n            \"SalesSubChannel\" => \"myshop.com\"\n        ])\n    ];\n\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n    $ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n                                   'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n    $ch, CURLOPT_USERPWD,\n    $apiUsername . ':' . $apiPassword\n);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($ch, CURLOPT_POSTFIELDS,json_encode($content));\n\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"post","auth":"required","params":[{"_id":"560d3313ac2859170013fb14","ref":"","in":"path","required":true,"desc":"The name of the transactional data collection, which needs to be included within the URL","default":"","type":"string","name":"CollectionName"},{"_id":"560e8b1fdfdd5a2100e8efdb","ref":"","in":"path","required":true,"desc":"The key for the piece of transactional data, which needs to be included within the URL","default":"","type":"string","name":"Key"},{"_id":"560e8b1fdfdd5a2100e8efd9","ref":"","in":"body","required":true,"desc":"This is the form in which transactional data is stored against a contact, as key-value pairs serialisable to JSON. This needs to be included within the request body.","default":"","type":"string","name":"Json"}],"url":"/v:version/contacts/transactional-data/[CollectionName]/[Key]"},"isReference":false,"order":7,"body":"This operation replaces a single piece of transactional data by key. The existing piece of transactional data attached to the key will be overwritten by the piece of transactional data in the request body.\n\nThis therefore makes it the logical equivalent to a delete and an insert.","excerpt":"Replaces a piece of transactional data by key","slug":"replace-transactional-data-by-key","type":"endpoint","title":"Replace transactional data by key"}

postReplace transactional data by key

Replaces a piece of transactional data by key

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

CollectionName:
required
string
The name of the transactional data collection, which needs to be included within the URL
Key:
required
string
The key for the piece of transactional data, which needs to be included within the URL

Body Params

Json:
required
string
This is the form in which transactional data is stored against a contact, as key-value pairs serialisable to JSON. This needs to be included within the request body.

Examples


Result Format


Documentation

This operation replaces a single piece of transactional data by key. The existing piece of transactional data attached to the key will be overwritten by the piece of transactional data in the request body. This therefore makes it the logical equivalent to a delete and an insert.