curl -X PATCH "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"campaign_uid": "cmp_4b1f7a92c3d84e05",
"contact_list_uid": "cl_2f9a4c71b8e6d305",
"contact_list_uids": []
}'import requests
url = "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/"
payload = {
"campaign_uid": "<string>",
"contact_list_uid": "<string>",
"contact_list_uids": ["<string>"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign_uid: '<string>',
contact_list_uid: '<string>',
contact_list_uids: ['<string>']
})
};
fetch('https://api.deliveryman.ai/api/v1/campaign/change-contact-list/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'campaign_uid' => '<string>',
'contact_list_uid' => '<string>',
'contact_list_uids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/"
payload := strings.NewReader("{\n \"campaign_uid\": \"<string>\",\n \"contact_list_uid\": \"<string>\",\n \"contact_list_uids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.deliveryman.ai/api/v1/campaign/change-contact-list/")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_uid\": \"<string>\",\n \"contact_list_uid\": \"<string>\",\n \"contact_list_uids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deliveryman.ai/api/v1/campaign/change-contact-list/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_uid\": \"<string>\",\n \"contact_list_uid\": \"<string>\",\n \"contact_list_uids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"campaign_uid": "<string>",
"contact_list_uid": "<string>",
"contact_list_uids": [
"<string>"
],
"task_started_on": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Change Campaign Contact List
Updates campaign to use a different set of contact lists, replacing the current ones. An address present in more than one list is only contacted once. This request starts a background task and might take a few minutes for changes to be reflected depending on the size of contact list. Campaign will be moved to creating status until done. Returns status code 202 upon successfully starting the update task. This operation can only be peformed on campaigns in created status.
curl -X PATCH "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"campaign_uid": "cmp_4b1f7a92c3d84e05",
"contact_list_uid": "cl_2f9a4c71b8e6d305",
"contact_list_uids": []
}'import requests
url = "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/"
payload = {
"campaign_uid": "<string>",
"contact_list_uid": "<string>",
"contact_list_uids": ["<string>"]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
campaign_uid: '<string>',
contact_list_uid: '<string>',
contact_list_uids: ['<string>']
})
};
fetch('https://api.deliveryman.ai/api/v1/campaign/change-contact-list/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'campaign_uid' => '<string>',
'contact_list_uid' => '<string>',
'contact_list_uids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.deliveryman.ai/api/v1/campaign/change-contact-list/"
payload := strings.NewReader("{\n \"campaign_uid\": \"<string>\",\n \"contact_list_uid\": \"<string>\",\n \"contact_list_uids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.deliveryman.ai/api/v1/campaign/change-contact-list/")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_uid\": \"<string>\",\n \"contact_list_uid\": \"<string>\",\n \"contact_list_uids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deliveryman.ai/api/v1/campaign/change-contact-list/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_uid\": \"<string>\",\n \"contact_list_uid\": \"<string>\",\n \"contact_list_uids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"campaign_uid": "<string>",
"contact_list_uid": "<string>",
"contact_list_uids": [
"<string>"
],
"task_started_on": "2023-11-07T05:31:56Z"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Your API key. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.
Body
UID of campaign to update.
Deprecated, use contact_list_uids instead. UID of contact list to use.
UIDs of the contact lists to use. Replaces the campaign's current lists. A campaign can target up to 10 lists.
10