Update contact book
curl --request PATCH \
--url https://app.usesend.com/api/v1/contactBooks/{contactBookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"emoji": "<string>",
"properties": {},
"doubleOptInEnabled": true,
"doubleOptInFrom": "<string>",
"doubleOptInSubject": "<string>",
"doubleOptInContent": "<string>",
"variables": [
"<string>"
]
}
'import requests
url = "https://app.usesend.com/api/v1/contactBooks/{contactBookId}"
payload = {
"name": "<string>",
"emoji": "<string>",
"properties": {},
"doubleOptInEnabled": True,
"doubleOptInFrom": "<string>",
"doubleOptInSubject": "<string>",
"doubleOptInContent": "<string>",
"variables": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
emoji: '<string>',
properties: {},
doubleOptInEnabled: true,
doubleOptInFrom: '<string>',
doubleOptInSubject: '<string>',
doubleOptInContent: '<string>',
variables: ['<string>']
})
};
fetch('https://app.usesend.com/api/v1/contactBooks/{contactBookId}', 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://app.usesend.com/api/v1/contactBooks/{contactBookId}",
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([
'name' => '<string>',
'emoji' => '<string>',
'properties' => [
],
'doubleOptInEnabled' => true,
'doubleOptInFrom' => '<string>',
'doubleOptInSubject' => '<string>',
'doubleOptInContent' => '<string>',
'variables' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.usesend.com/api/v1/contactBooks/{contactBookId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"properties\": {},\n \"doubleOptInEnabled\": true,\n \"doubleOptInFrom\": \"<string>\",\n \"doubleOptInSubject\": \"<string>\",\n \"doubleOptInContent\": \"<string>\",\n \"variables\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.usesend.com/api/v1/contactBooks/{contactBookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"properties\": {},\n \"doubleOptInEnabled\": true,\n \"doubleOptInFrom\": \"<string>\",\n \"doubleOptInSubject\": \"<string>\",\n \"doubleOptInContent\": \"<string>\",\n \"variables\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.usesend.com/api/v1/contactBooks/{contactBookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"properties\": {},\n \"doubleOptInEnabled\": true,\n \"doubleOptInFrom\": \"<string>\",\n \"doubleOptInSubject\": \"<string>\",\n \"doubleOptInContent\": \"<string>\",\n \"variables\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "clx1234567890",
"name": "Newsletter Subscribers",
"teamId": 1,
"properties": {
"customField1": "value1"
},
"variables": [
"registrationCode",
"company"
],
"emoji": "📙",
"createdAt": "<string>",
"updatedAt": "<string>",
"doubleOptInEnabled": true,
"doubleOptInFrom": "Newsletter <[email protected]>",
"doubleOptInSubject": "Please confirm your subscription",
"doubleOptInContent": "<string>",
"_count": {
"contacts": 123
}
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
"clx1234567890"
Body
Response
Update the contact book
The ID of the contact book
"clx1234567890"
The name of the contact book
"Newsletter Subscribers"
The ID of the team
1
Custom properties for the contact book
Show child attributes
Show child attributes
{ "customField1": "value1" }
Allowed personalization variables for contacts in this book
["registrationCode", "company"]
The emoji associated with the contact book
"📙"
The creation timestamp
The last update timestamp
Whether double opt-in is enabled for new contacts
true
From address used for double opt-in emails (must use a verified domain)
"Newsletter <[email protected]>"
Subject line used for double opt-in confirmation email
"Please confirm your subscription"
Email editor JSON content used for double opt-in confirmation
Show child attributes
Show child attributes
curl --request PATCH \
--url https://app.usesend.com/api/v1/contactBooks/{contactBookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"emoji": "<string>",
"properties": {},
"doubleOptInEnabled": true,
"doubleOptInFrom": "<string>",
"doubleOptInSubject": "<string>",
"doubleOptInContent": "<string>",
"variables": [
"<string>"
]
}
'import requests
url = "https://app.usesend.com/api/v1/contactBooks/{contactBookId}"
payload = {
"name": "<string>",
"emoji": "<string>",
"properties": {},
"doubleOptInEnabled": True,
"doubleOptInFrom": "<string>",
"doubleOptInSubject": "<string>",
"doubleOptInContent": "<string>",
"variables": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
emoji: '<string>',
properties: {},
doubleOptInEnabled: true,
doubleOptInFrom: '<string>',
doubleOptInSubject: '<string>',
doubleOptInContent: '<string>',
variables: ['<string>']
})
};
fetch('https://app.usesend.com/api/v1/contactBooks/{contactBookId}', 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://app.usesend.com/api/v1/contactBooks/{contactBookId}",
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([
'name' => '<string>',
'emoji' => '<string>',
'properties' => [
],
'doubleOptInEnabled' => true,
'doubleOptInFrom' => '<string>',
'doubleOptInSubject' => '<string>',
'doubleOptInContent' => '<string>',
'variables' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.usesend.com/api/v1/contactBooks/{contactBookId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"properties\": {},\n \"doubleOptInEnabled\": true,\n \"doubleOptInFrom\": \"<string>\",\n \"doubleOptInSubject\": \"<string>\",\n \"doubleOptInContent\": \"<string>\",\n \"variables\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.usesend.com/api/v1/contactBooks/{contactBookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"properties\": {},\n \"doubleOptInEnabled\": true,\n \"doubleOptInFrom\": \"<string>\",\n \"doubleOptInSubject\": \"<string>\",\n \"doubleOptInContent\": \"<string>\",\n \"variables\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.usesend.com/api/v1/contactBooks/{contactBookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"properties\": {},\n \"doubleOptInEnabled\": true,\n \"doubleOptInFrom\": \"<string>\",\n \"doubleOptInSubject\": \"<string>\",\n \"doubleOptInContent\": \"<string>\",\n \"variables\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "clx1234567890",
"name": "Newsletter Subscribers",
"teamId": 1,
"properties": {
"customField1": "value1"
},
"variables": [
"registrationCode",
"company"
],
"emoji": "📙",
"createdAt": "<string>",
"updatedAt": "<string>",
"doubleOptInEnabled": true,
"doubleOptInFrom": "Newsletter <[email protected]>",
"doubleOptInSubject": "Please confirm your subscription",
"doubleOptInContent": "<string>",
"_count": {
"contacts": 123
}
}{
"error": "<string>"
}{
"error": "<string>"
}