{"_id":"55def82cddfb40170061ced3","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":"55dd9841cafe7221002a4c62","__v":14,"editedParams":true,"editedParams2":true,"githubsync":"","project":"55dd9f2e0efd5821000d54d9","parentDoc":null,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-27T11:44:44.492Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"var url = \"/v2/address-books/1/contacts/resubscribe\";\nvar content = :::at:::\"{ unsubscribedContact: { email: \"\"nelson.redeker@example.com\"\" } }\";\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}\n","language":"csharp"},{"code":"{ \n  \"unsubscribedContact\": {\n    \"email\": \"nelson.redeker@example.com\" \n  }\n}","language":"json"},{"language":"php","code":"$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/address-books/1/contacts/resubscribe\";\n\n$content = [\n    \"unsubscribedContact\" => [\n        \"email\" =>  \"nelson.redeker@example.com\"\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));"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"contact\": {\n    \"id\": 24,\n    \"email\": \"nelson.redeker@example.com\",\n    \"optInType\": \"Unknown\",\n    \"emailType\": \"PlainText\",\n    \"dataFields\": null,\n    \"status\": \"Subscribed\"\n  },\n  \"status\": \"ContactAdded\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55def82cddfb40170061ced5","ref":"","in":"path","required":true,"desc":"The ID of the address book, which needs to be included within the URL","default":"","type":"int","name":"ID"},{"_id":"55def82cddfb40170061ced4","ref":"","in":"body","required":true,"desc":"The email address of the unsubscribed contact, which needs to be included within the request body","default":"","type":"string","name":"UnsubscribedContact.Email"},{"_id":"5afc5fd9f7edf8000381ba75","ref":"","in":"body","required":false,"desc":"Each data field is a key-value pair; the key is a string and the value can be of any type","default":"","type":"string","name":"UnsubscribedContact.DataFields"}],"url":"/v:version/address-books/[ID]/contacts/resubscribe"},"isReference":false,"order":31,"body":"This operation resubscribes an unsubscribed contact to a specified address book and returns their resubscribe status.\n\nPlease note that you can include, and thus update, contact data fields when resubscribing a contact to an address book using this operation. Code examples for this are included below: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var url = \\\"/v2/address-books/1/contacts/resubscribe\\\";\\nvar content = @\\\"{ unsubscribedContact: { email: \\\"\\\"nelson.redeker@example.com\\\"\\\", dataFields: [ { key: \\\"\\\"FIRSTNAME\\\"\\\", value: \\\"\\\"Nelson\\\"\\\" }, { key: \\\"\\\"LASTNAME\\\"\\\", value: \\\"\\\"Redeker\\\"\\\" } ] }\\\";\\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}\",\n      \"language\": \"csharp\"\n    },\n    {\n      \"code\": \"{ \\n  \\\"unsubscribedContact\\\": {\\n    \\\"email\\\": \\\"nelson.redeker@example.com\\\", \\n    \\\"dataFields\\\": [\\n        {\\n            \\\"key\\\": \\\"FIRSTNAME\\\",\\n            \\\"value\\\": \\\"Nelson\\\"\\n        },\\n       {\\n            \\\"key\\\": \\\"LASTNAME\\\",\\n            \\\"value\\\": \\\"Redeker\\\"\\n        }\\n      ]\\n  } \\n}\",\n      \"language\": \"json\"\n    },\n    {\n      \"code\": \"$baseUrl = 'https://api.dotmailer.com';\\n$url = $baseUrl . \\\"/v2/address-books/1/contacts/resubscribe\\\";\\n\\n$content = [\\n    \\\"unsubscribedContact\\\" => [\\n        \\\"email\\\" =>  \\\"nelson.redeker@example.com\\\",\\n        \\\"dataFields\\\" => [\\n        [\\\"key\\\" => \\\"FIRSTNAME\\\",\\n         \\\"value\\\" => \\\"Nelson\\\"],\\n        [\\\"key\\\" => \\\"LASTNAME\\\",\\n         \\\"value\\\" => \\\"Redeker\\\"]\\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));\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\nThe resubscribe status should come back as 'ContactAdded'.\n\nResubscribe status types can be:\n\n  * 'ContactAdded' - The contact has been successfully resubscribed to the address book\n  * 'ContactChallenged' - The contact has been sent an automated resubscribe email, asking them to confirm their resubscription\n  * 'ContactCannotBeUnsuppressed' - The contact can't be resubscribed. This may be because the contact is on the Global Suppression List (GSL), or their domain has been suppressed from receiving your campaigns, or the contact was removed because of a complaint from their ISP. You may want to contact support.\n  * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using","excerpt":"Resubscribes a previously unsubscribed contact to a given address book","slug":"resubscribe-contact-to-address-book","type":"endpoint","title":"Resubscribe contact to address book"}

postResubscribe contact to address book

Resubscribes a previously unsubscribed contact to a given address book

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The ID of the address book, which needs to be included within the URL

Body Params

UnsubscribedContact.Email:
required
string
The email address of the unsubscribed contact, which needs to be included within the request body
UnsubscribedContact.DataFields:
string
Each data field is a key-value pair; the key is a string and the value can be of any type

Examples


Result Format


Documentation

This operation resubscribes an unsubscribed contact to a specified address book and returns their resubscribe status. Please note that you can include, and thus update, contact data fields when resubscribing a contact to an address book using this operation. Code examples for this are included below: [block:code] { "codes": [ { "code": "var url = \"/v2/address-books/1/contacts/resubscribe\";\nvar content = @\"{ unsubscribedContact: { email: \"\"nelson.redeker@example.com\"\", dataFields: [ { key: \"\"FIRSTNAME\"\", value: \"\"Nelson\"\" }, { key: \"\"LASTNAME\"\", value: \"\"Redeker\"\" } ] }\";\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}", "language": "csharp" }, { "code": "{ \n \"unsubscribedContact\": {\n \"email\": \"nelson.redeker@example.com\", \n \"dataFields\": [\n {\n \"key\": \"FIRSTNAME\",\n \"value\": \"Nelson\"\n },\n {\n \"key\": \"LASTNAME\",\n \"value\": \"Redeker\"\n }\n ]\n } \n}", "language": "json" }, { "code": "$baseUrl = 'https://api.dotmailer.com';\n$url = $baseUrl . \"/v2/address-books/1/contacts/resubscribe\";\n\n$content = [\n \"unsubscribedContact\" => [\n \"email\" => \"nelson.redeker@example.com\",\n \"dataFields\" => [\n [\"key\" => \"FIRSTNAME\",\n \"value\" => \"Nelson\"],\n [\"key\" => \"LASTNAME\",\n \"value\" => \"Redeker\"]\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" } ] } [/block] The resubscribe status should come back as 'ContactAdded'. Resubscribe status types can be: * 'ContactAdded' - The contact has been successfully resubscribed to the address book * 'ContactChallenged' - The contact has been sent an automated resubscribe email, asking them to confirm their resubscription * 'ContactCannotBeUnsuppressed' - The contact can't be resubscribed. This may be because the contact is on the Global Suppression List (GSL), or their domain has been suppressed from receiving your campaigns, or the contact was removed because of a complaint from their ISP. You may want to contact support. * 'NotAvailableInThisVersion' - This feature is not available in the version of the API you're using