{"_id":"55f1872e5fe76419007dc703","project":"55dd9f2e0efd5821000d54d9","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"},"__v":2,"editedParams":true,"parentDoc":null,"category":{"_id":"55f036938eeefc23001ea5de","version":"55dd9f4dab0e4d210045aae9","pages":["55f1895d5fe76419007dc70b","55f18a6b9f818e1900f00974"],"project":"55dd9f2e0efd5821000d54d9","__v":2,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:39:31.128Z","from_sync":false,"order":6,"slug":"contact-data-fields","title":"Contact data fields"},"editedParams2":true,"user":"55dd9841cafe7221002a4c62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-10T13:35:42.817Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"csharp","code":"var url = \"/v2/data-fields\";\nvar content = :::at:::\"{ name: \"\"BIRTHDAY\"\", type: \"\"Date\"\" }\";\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\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}","name":""},{"code":"{ \n  \"name\": \"BIRTHDAY\",\n  \"type\": \"Date\" \n}","language":"json"},{"code":"$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/data-fields\";\n\n$content['Name'] = 'BIRTHDAY';\n$content['Type'] = 'Date';\n$content['Visibilty'] = 'Public';\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","results":{"codes":[{"name":"","code":"{\n  \"name\": \"BIRTHDAY\",\n  \"type\": \"Date\",\n  \"visibility\": \"Private\",\n  \"defaultValue\": null\n}","language":"json","status":201}]},"settings":"","auth":"required","params":[{"_id":"55def82cddfb40170061ced5","ref":"","in":"body","required":true,"desc":"The name of the contact data field being created, can only be up to 20 characters in length and must consist of alphnumeric characters only, with hyphens and underscores if required. This needs to be included within the request body.","default":"","type":"string","name":"Name"},{"_id":"55f1891e5f255523008fae97","ref":"","in":"body","required":true,"desc":"The data type of the contact data field being created","default":"'String', 'Numeric', 'Date', 'Boolean'","type":"string","name":"Type"},{"_id":"55f1891e5f255523008fae96","ref":"","in":"body","required":false,"desc":"All contact data fields are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to. This needs to be included within the request body.","default":"'Private', 'Public'","type":"string","name":"Visibility"},{"_id":"55f1891e5f255523008fae95","ref":"","in":"body","required":false,"desc":"The default value can be any data type","default":"","type":"mixed","name":"DefaultValue"}],"url":"/v:version/data-fields"},"isReference":false,"order":0,"body":"This operation can be used to create a contact data field within your account. \n\nYou can't create a contact data field that already exists. If you are unsure which data fields currently exist, please call Get Contact Data Fields. \n\nThe contact data field's name can only be up to 20 characters in length and must consist of alphanumeric characters only, with hyphens and underscores if required. The contact data field that is created will be private by default. The amount of contact data fields you can create will be limited by the account type you have.","excerpt":"Creates a contact data field within the account","slug":"create-contact-data-field","type":"endpoint","title":"Create contact data field"}

postCreate contact data field

Creates a contact data field within the account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

Name:
required
string
The name of the contact data field being created, can only be up to 20 characters in length and must consist of alphnumeric characters only, with hyphens and underscores if required. This needs to be included within the request body.
Type:
required
string'String', 'Numeric', 'Date', 'Boolean'
The data type of the contact data field being created
Visibility:
string'Private', 'Public'
All contact data fields are created as 'Private' by default but you can set it as 'Public' upon creation should you wish to. This needs to be included within the request body.
DefaultValue:
mixed
The default value can be any data type

Examples


Result Format


Documentation

This operation can be used to create a contact data field within your account. You can't create a contact data field that already exists. If you are unsure which data fields currently exist, please call Get Contact Data Fields. The contact data field's name can only be up to 20 characters in length and must consist of alphanumeric characters only, with hyphens and underscores if required. The contact data field that is created will be private by default. The amount of contact data fields you can create will be limited by the account type you have.