Send a confirmation document to a specific recipient. This implements the double-opt-in logic. Recipients in the confirmation status will not be sent additional emails until they confirm their interest. The Document name provided must exist in the system and be of type 'Confirm'. Only existing recipients can be sent a double-opt-in message — create the recipient before calling this routine.
Put
/API/Rest/Confirmations/Send
emailAddress
documentName
CreateEditMember
No Permission
Invalid document name
That document is not used for confirmations
Email address not found in the database
Database error
Unknown error
Success
Send a conformation to one recipient.
using System;
using System.Net.Http;
string url = "https://example.com/API/Rest/Confirmations/Send?accountName=acme&login=ApiUser&emailAddress=joe@example.com&documentName=Confirm1";
// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Put, url))
{
request.Headers.Add("Password", "YOUR_PASSWORD");
using (HttpResponseMessage response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
}
}
# encoding: utf-8
require 'rest-client'
require 'json'
url = 'https://example.com/API/Rest/Confirmations/Send?accountName=Acme&login=ApiUser&emailAddress=joe@example.com&documentName=Confirm1'
response = RestClient.put(url, "", {:Password => "YOUR_PASSWORD"})
puts response
import requests
url = "https://example.com/API/Rest/Confirmations/Send?accountName=Acme&login=ApiUser&emailAddress=joe@example.com&documentName=Confirm1"
headers = {'password':'YOUR_PASSWORD'}
resp = requests.put(url, headers=headers)
if resp.status_code == 200:
print(resp.text)
curl --request PUT --header "Password: YOUR_PASSWORD" "https://example.com/API/Rest/Confirmations/Send?accountName=acme&login=ApiUser&emailAddress=joe@example.com&documentName=Confirm1"