Update Contact
curl --request PATCH \
--url https://api.getoutbox.ai/contacts/{contact_id}/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"business_name": "<string>",
"notes": "<string>",
"tags": [
"<string>"
],
"is_dnd": true,
"lead_source": "<string>",
"custom_fields": {}
}
'import requests
url = "https://api.getoutbox.ai/contacts/{contact_id}/"
payload = {
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"business_name": "<string>",
"notes": "<string>",
"tags": ["<string>"],
"is_dnd": True,
"lead_source": "<string>",
"custom_fields": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
full_name: '<string>',
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone_number: '<string>',
business_name: '<string>',
notes: '<string>',
tags: ['<string>'],
is_dnd: true,
lead_source: '<string>',
custom_fields: {}
})
};
fetch('https://api.getoutbox.ai/contacts/{contact_id}/', 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.getoutbox.ai/contacts/{contact_id}/",
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([
'full_name' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'business_name' => '<string>',
'notes' => '<string>',
'tags' => [
'<string>'
],
'is_dnd' => true,
'lead_source' => '<string>',
'custom_fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.getoutbox.ai/contacts/{contact_id}/"
payload := strings.NewReader("{\n \"full_name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"business_name\": \"<string>\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_dnd\": true,\n \"lead_source\": \"<string>\",\n \"custom_fields\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.getoutbox.ai/contacts/{contact_id}/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"full_name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"business_name\": \"<string>\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_dnd\": true,\n \"lead_source\": \"<string>\",\n \"custom_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoutbox.ai/contacts/{contact_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"full_name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"business_name\": \"<string>\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_dnd\": true,\n \"lead_source\": \"<string>\",\n \"custom_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"business_name": "<string>",
"notes": "<string>",
"tags": [
"<string>"
],
"is_dnd": true,
"profile_picture_url": "<string>",
"last_activity": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}Contact Endpoints
Update Contact
Update an existing contact. Only fields present in the JSON body are applied.
PATCH
/
contacts
/
{contact_id}
/
Update Contact
curl --request PATCH \
--url https://api.getoutbox.ai/contacts/{contact_id}/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"business_name": "<string>",
"notes": "<string>",
"tags": [
"<string>"
],
"is_dnd": true,
"lead_source": "<string>",
"custom_fields": {}
}
'import requests
url = "https://api.getoutbox.ai/contacts/{contact_id}/"
payload = {
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"business_name": "<string>",
"notes": "<string>",
"tags": ["<string>"],
"is_dnd": True,
"lead_source": "<string>",
"custom_fields": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
full_name: '<string>',
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone_number: '<string>',
business_name: '<string>',
notes: '<string>',
tags: ['<string>'],
is_dnd: true,
lead_source: '<string>',
custom_fields: {}
})
};
fetch('https://api.getoutbox.ai/contacts/{contact_id}/', 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.getoutbox.ai/contacts/{contact_id}/",
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([
'full_name' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'phone_number' => '<string>',
'business_name' => '<string>',
'notes' => '<string>',
'tags' => [
'<string>'
],
'is_dnd' => true,
'lead_source' => '<string>',
'custom_fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.getoutbox.ai/contacts/{contact_id}/"
payload := strings.NewReader("{\n \"full_name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"business_name\": \"<string>\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_dnd\": true,\n \"lead_source\": \"<string>\",\n \"custom_fields\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.getoutbox.ai/contacts/{contact_id}/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"full_name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"business_name\": \"<string>\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_dnd\": true,\n \"lead_source\": \"<string>\",\n \"custom_fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoutbox.ai/contacts/{contact_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"full_name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"business_name\": \"<string>\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"is_dnd\": true,\n \"lead_source\": \"<string>\",\n \"custom_fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"business_name": "<string>",
"notes": "<string>",
"tags": [
"<string>"
],
"is_dnd": true,
"profile_picture_url": "<string>",
"last_activity": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
Company API Key
Path Parameters
The ID of the contact
Body
application/json
Fields to update (all optional; only sent keys are applied)
All fields optional; only keys present in the request are applied.
Also updates first_name and last_name via parse_name_fields
Empty string is stored as null
Assigned as provided (no normalization in this handler)
Replaces the entire tags array
Same allowed values as create: manual, api, webhook, facebook, instagram, import
Same semantics as POST: only keys that exist as company CustomField names are stored.
Show child attributes
Show child attributes
Response
Contact updated successfully
Response body for PATCH /contacts/{contact_id}/
Available options:
manual, api, webhook, facebook, instagram, import ⌘I

