{"_id":"5bb5e8ad54d2dc0003988c98","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"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","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55e047b258c5460d0076a9a7","__v":24,"project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","pages":["55ed71142bdb6a2d0064f216","55ed71e1a872a80d00acff1a","55ed72a8df21af2b009e215f","55ef03aae7f5490d000c0dfd","55f1872e5fe76419007dc703","55f2af86d1c4c7170033df2b","55f2d812525cb12300c6c517","55f2db08c93a2d230062f971","55f2deaacb01c71900c8e218","55f2e024fb7aad2300bf1823","55f2e1f6525cb12300c6c554","55f2e47ffb7aad2300bf182b","55f2ea90525cb12300c6c56c","55f2ed9ecb01c71900c8e24a","55f2f26f71c6462100e0fdf1","55f2f2e3c93a2d230062f9af","55f2f3bdc93a2d230062f9b1","55fc1d6ae013770d008fcbf3","55fc249ff4dbbf0d008f43ef","55fc2bd3e013770d008fcc0b","55ffda3d8c0c9d0d00dcacb4","55ffdf828c0c9d0d00dcacba","55ffe1a56932a00d00ba7abc","560d322c3616cf0d00a8cc97"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-28T11:36:18.041Z","from_sync":false,"order":8,"slug":"contacts","title":"Contacts"},"user":"5a251846c297dc0012e531cd","__v":16,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-04T10:17:17.618Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n  \"contact\": {\n    \"email\": \"john.smith:::at:::example.com\",\n    \"optInType\": \"Unknown\",\n    \"emailType\": \"Html\",\n    \"dataFields\": [\n      {\n        \"key\": \"FIRSTNAME\",\n        \"value\": \"John\"\n      },\n      {\n        \"key\": \"FULLNAME\",\n        \"value\": \"John Smith\"\n      },\n      {\n        \"key\": \"GENDER\",\n        \"value\": \"Male\"\n      },\n      {\n        \"key\": \"LASTNAME\",\n        \"value\": \"Smith\"\n      },\n      {\n        \"key\": \"LASTSUBSCRIBED\",\n        \"value\": \"2018-02-28T08:07:01.441\"\n      },\n      {\n        \"key\": \"POSTCODE\",\n        \"value\": \"N5 1DP\"\n      }\n    ]\n  },\n  \"consentFields\": [\n    {\n      \"fields\": [\n        {\n          \"key\": \"TEXT\",\n          \"value\": \"Your consent text goes here.\"\n        },\n        {\n          \"key\": \"DATETIMECONSENTED\",\n          \"value\": \"2018-01-26T21:29:00\"\n        },\n        {\n          \"key\": \"URL\",\n          \"value\": \"http://www.example.com/signup\"\n        },\n        {\n          \"key\": \"IPADDRESS\",\n          \"value\": \"127.0.0.1\"\n        },\n        {\n          \"key\": \"USERAGENT\",\n          \"value\": \"Mozilla/5.0 (X11; OpenBSD i386) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36\"\n        }\n      ]\n    }\n  ],\n  \"preferences\": [\n    {\n      \"id\": 1,\n      \"isPreference\": false,\n      \"preferences\": [\n        {\n          \"id\": 2,\n          \"isPreference\": true,\n          \"isOptedIn\": true\n        },\n        {\n          \"id\": 3,\n          \"isPreference\": true,\n          \"isOptedIn\": false\n        }\n      ]\n    },\n    {\n      \"id\": 4,\n      \"isPreference\": true,\n      \"isOptedIn\": true\n    }\n  ]\n}"},{"code":"var url = \"/v2/contacts/with-consent-and-preferences\";\nvar content = @\"{\n   \"\"contact\"\": {\n    \"\"email\"\": \"\"john.smith@example.com\"\",\n    \"\"optInType\"\": \"\"Unknown\"\",\n    \"\"emailType\"\": \"\"Html\"\",\n    \"\"dataFields\"\": [\n        {\n        \"\"key\"\": \"\"FIRSTNAME\"\",\n        \"\"value\"\": \"\"John\"\"\n        },\n        {\n        \"\"key\"\": \"\"FULLNAME\"\",\n        \"\"value\"\": \"\"John Smith\"\"\n        },\n        {\n        \"\"key\"\": \"\"GENDER\"\",\n        \"\"value\"\": \"\"Male\"\"\n        },\n        {\n        \"\"key\"\": \"\"LASTNAME\"\",\n        \"\"value\"\": \"\"Smith\"\"\n        },\n        {\n        \"\"key\"\": \"\"LASTSUBSCRIBED\"\",\n        \"\"value\"\": \"\"2018-02-28T08:07:01.441\"\"\n        },\n        {\n        \"\"key\"\": \"\"POSTCODE\"\",\n        \"\"value\"\": \"\"N5 1DP\"\"\n        }\n    ],\n    \"\"status\"\": \"\"Subscribed\"\"\n    },\n    \"\"consentFields\"\": [\n    {\n        \"\"fields\"\": [\n        {\n        \"\"key\"\": \"\"text\"\",\n        \"\"value\"\": \"\"Your consent text goes here.\"\"\n        },\n        {\n        \"\"key\"\": \"\"datetimeconsented\"\",\n        \"\"value\"\": \"\"2018-01-26T21:29:00\"\"\n        },\n        {\n        \"\"key\"\": \"\"url\"\",\n        \"\"value\"\": \"\"https://www.dotmailer.com/demo/\"\"\n        },\n        {\n        \"\"key\"\": \"\"ipaddress\"\",\n        \"\"value\"\": \"\"89.96.126.159\"\"\n        },\n        {\n        \"\"key\"\": \"\"useragent\"\",\n        \"\"value\"\": \"\"Mozilla/5.0 (X11; OpenBSD i386) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36\"\"\n        }\n        ]\n    }\n    ],\n    \"\"preferences\"\": [\n    {\n    \"\"id\"\": 1,\n        \"\"isPreference\"\": false,\n        \"\"preferences\"\": [\n        {\n          \"\"id\"\": 2,\n            \"\"isPreference\"\": true,\n            \"\"isOptedIn\"\": true\n        },\n        {\n            \"\"id\"\": 3,\n            \"\"isPreference\"\": true,\n            \"\"isOptedIn\"\": false\n        }\n        ]\n    },\n    {\n        \"\"id\"\": 4,\n       \"\"isPreference\"\": true,\n        \"\"isOptedIn\"\": true\n    }\n    ]\n}\";\n\nusing (var httpClient = new HttpClient())\n{\n    httpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n    var credentials = Encoding.ASCII.GetBytes(\"username:password\");\n   httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n    var result = httpClient.PostAsync(url, new StringContent(content, Encoding.UTF8, \"application/json\")).Result;\n}","language":"csharp"}]},"results":{"codes":[{"name":"","code":"{\n  \"contact\": {\n    \"id\": 1,\n    \"email\": \"john.smith@example.com\",\n    \"optInType\": \"Unknown\",\n    \"emailType\": \"Html\",\n    \"dataFields\": [\n      {\n        \"key\": \"FIRSTNAME\",\n        \"value\": \"John\"\n      },\n      {\n        \"key\": \"FULLNAME\",\n        \"value\": \"John Smith\"\n      },\n      {\n        \"key\": \"GENDER\",\n        \"value\": \"Male\"\n      },\n      {\n        \"key\": \"LASTNAME\",\n        \"value\": \"Smith\"\n      },\n      {\n        \"key\": \"LASTSUBSCRIBED\",\n        \"value\": \"2018-02-28T08:07:01Z\"\n      },\n    {\n        \"key\": \"POSTCODE\",\n        \"value\": \"N5 1DP\"\n      }\n    ],\n    \"status\": \"Subscribed\"\n  },\n  \"consentFields\": [\n    {\n      \"id\": null,\n      \"fields\": [\n        {\n          \"key\": \"TEXT\",\n          \"value\": \"Yes, I would like to receive a monthly newsletter\"\n        },\n        {\n          \"key\": \"DATETIMECONSENTED\",\n          \"value\": \"2018-01-26T21:29:00\"\n        },\n        {\n          \"key\": \"URL\",\n          \"value\": \"http://www.example.com/signup\"\n        },\n        {\n          \"key\": \"IPADDRESS\",\n          \"value\": \"127.0.0.1\"\n        },\n        {\n          \"key\": \"USERAGENT\",\n          \"value\": \"Mozilla/5.0 (X11; OpenBSD i386) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125 Safari/537.36\"\n        }\n      ]\n    }\n  ],\n  \"preferences\": [\n    {\n      \"id\": 1,\n      \"publicName\": \"test category\",\n      \"privateName\": \"test category\",\n      \"isPreference\": false,\n      \"order\": \"0\",\n      \"isPublic\": true,\n      \"categoryId\": 0,\n      \"preferenceCount\": 2,\n      \"created\": \"2018-09-05T14:15:05\",\n      \"lastModified\": \"2018-09-27T12:32:19\",\n      \"preferences\": [\n        {\n          \"id\": 2,\n          \"publicName\": \"test preference\",\n          \"privateName\": \"test preference\",\n          \"isPreference\": true,\n          \"order\": \"0\",\n          \"isPublic\": true,\n          \"categoryId\": 1,\n          \"preferenceCount\": 0,\n          \"created\": \"2018-09-20T09:26:08\",\n          \"lastModified\": \"2018-09-27T12:32:19\",\n          \"isOptedIn\": false\n        },\n        {\n          \"id\": 3,\n          \"publicName\": \"test preference 2\",\n          \"privateName\": \"test preference 2\",\n          \"isPreference\": true,\n          \"order\": \"1\",\n          \"isPublic\": true,\n          \"categoryId\": 1,\n          \"preferenceCount\": 0,\n          \"created\": \"2018-09-20T09:26:08\",\n          \"lastModified\": \"2018-09-27T12:32:19\",\n          \"isOptedIn\": false\n        }\n      ],\n      {\n        \"id\": 4,\n        \"publicName\": \"test preference 3\",\n        \"privateName\": \"test preference 3\",\n        \"isPreference\": true,\n        \"order\": \"1\",\n        \"isPublic\": false,\n        \"categoryId\": 0,\n        \"preferenceCount\": 0,\n        \"created\": \"2018-09-18T13:37:11\",\n        \"lastModified\": \"2018-09-27T12:32:19\",\n        \"isOptedIn\": false\n      }\n    }\n  ]\n}\n","language":"json","status":200}]},"settings":"","method":"post","auth":"required","params":[{"_id":"5bb5e8e954d2dc0003988c9b","ref":"","in":"body","required":true,"desc":"The email address of the contact.","default":"","type":"string","name":"Email"},{"_id":"5bb5e99ea1c16c00038048b9","ref":"","in":"body","required":false,"desc":"The opt-in type of the contact.","default":"'Unknown', 'Single', 'Double', 'VerifiedDouble'","type":"string","name":"OptInType"},{"_id":"5bb5e99ea1c16c00038048b8","ref":"","in":"body","required":false,"desc":"The email type of the contact.","default":"'PlainText', 'Html'","type":"string","name":"EmailType"},{"_id":"5bb5ea4d54d2dc0003988ce1","ref":"","in":"body","required":false,"desc":"Each contact data field is a key-value pair; the key is a string.","default":"","type":"string","name":"DataFields.key"},{"_id":"5bb5ea4d54d2dc0003988ce0","ref":"","in":"body","required":false,"desc":"Each contact data field is a key-value pair; the value can be of any type.","default":"","type":"mixed","name":"DataFields.value"},{"_id":"5bb5eb53a1c16c00038048f1","ref":"","in":"body","required":false,"desc":"Each ConsentInsight data record is a key-value pair; the key is a string.","default":"'Text', 'DateTimeConsented', 'URL', 'IPAddress', 'UserAgent'","type":"string","name":"ConsentFields.Key"},{"_id":"5bb5eb53a1c16c00038048f0","ref":"","in":"body","required":false,"desc":"Each ConsentInsight data record is a key-value pair; the value can be of any type.","default":"","type":"mixed","name":"ConsentFields.value"},{"_id":"5bb5eb53a1c16c00038048ef","ref":"","in":"body","required":false,"desc":"An array of preference and preference category objects.","default":"","type":"array_object","name":"Preferences"}],"url":"/v:version/contacts/with-consent-and-preferences"},"isReference":false,"order":2,"body":"This operation creates a contact in your 'All contacts' address book and gives that contact ConsentInsight data and marketing preferences.\n\nIf you set the `OptInType` to 'VerifiedDouble',  a double opt-in confirmation email will be sent to the contact, and the result will state that the contact's `OptInType` is 'Double' and `Status` is 'PendingOptIn'. These keys will only update to 'VerifiedDouble' and 'Subscribed' respectively once the contact has clicked the link in the confirmation email, at which point they will be added to the account.\n\nTo opt in contacts to preferences, set the `isOptedIn` key to `true`\n\nTo opt out contacts from preferences, set the `isOptedIn` key to `false`, or do not specify those preferences in the request body.\n\nNote that this operation can be used to update an existing contact. If the contact already exists, a duplicate contact will not be created, and any data provided in your request that is already held for the contact will be overwritten and updated in the system.","excerpt":"Creates a contact with ConsentInsight data and marketing preferences","slug":"create-contact-with-consent-and-preferences","type":"endpoint","title":"Create contact with consent and preferences"}

postCreate contact with consent and preferences

Creates a contact with ConsentInsight data and marketing preferences

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

Email:
required
string
The email address of the contact.
OptInType:
string'Unknown', 'Single', 'Double', 'VerifiedDouble'
The opt-in type of the contact.
EmailType:
string'PlainText', 'Html'
The email type of the contact.
DataFields.key:
string
Each contact data field is a key-value pair; the key is a string.
DataFields.value:
mixed
Each contact data field is a key-value pair; the value can be of any type.
ConsentFields.Key:
string'Text', 'DateTimeConsented', 'URL', 'IPAddress', 'UserAgent'
Each ConsentInsight data record is a key-value pair; the key is a string.
ConsentFields.value:
mixed
Each ConsentInsight data record is a key-value pair; the value can be of any type.
Preferences:
array of objects
An array of preference and preference category objects.

Examples


Result Format


Documentation

This operation creates a contact in your 'All contacts' address book and gives that contact ConsentInsight data and marketing preferences. If you set the `OptInType` to 'VerifiedDouble', a double opt-in confirmation email will be sent to the contact, and the result will state that the contact's `OptInType` is 'Double' and `Status` is 'PendingOptIn'. These keys will only update to 'VerifiedDouble' and 'Subscribed' respectively once the contact has clicked the link in the confirmation email, at which point they will be added to the account. To opt in contacts to preferences, set the `isOptedIn` key to `true` To opt out contacts from preferences, set the `isOptedIn` key to `false`, or do not specify those preferences in the request body. Note that this operation can be used to update an existing contact. If the contact already exists, a duplicate contact will not be created, and any data provided in your request that is already held for the contact will be overwritten and updated in the system.