curl --request PATCH \
--url https://api.getoneprofile.ai/sender-profiles/{profile_id}/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"booking_url": "<string>",
"confirm": false,
"first_name": "<string>",
"last_name": "<string>",
"signature_text": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/sender-profiles/{profile_id}/"
payload = {
"booking_url": "<string>",
"confirm": False,
"first_name": "<string>",
"last_name": "<string>",
"signature_text": "<string>",
"title": "<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({
booking_url: '<string>',
confirm: false,
first_name: '<string>',
last_name: '<string>',
signature_text: '<string>',
title: '<string>'
})
};
fetch('https://api.getoneprofile.ai/sender-profiles/{profile_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.getoneprofile.ai/sender-profiles/{profile_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([
'booking_url' => '<string>',
'confirm' => false,
'first_name' => '<string>',
'last_name' => '<string>',
'signature_text' => '<string>',
'title' => '<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.getoneprofile.ai/sender-profiles/{profile_id}/"
payload := strings.NewReader("{\n \"booking_url\": \"<string>\",\n \"confirm\": false,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"signature_text\": \"<string>\",\n \"title\": \"<string>\"\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.getoneprofile.ai/sender-profiles/{profile_id}/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"booking_url\": \"<string>\",\n \"confirm\": false,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"signature_text\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sender-profiles/{profile_id}/")
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 \"booking_url\": \"<string>\",\n \"confirm\": false,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"signature_text\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"booking_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailbox_count": 123,
"name": "<string>",
"send_mode": "always_send",
"status": "draft",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"daily_limit": 0,
"email_approval_mode": "manual",
"first_name": "",
"last_name": "",
"linkedin_connection_request_cap": 0,
"linkedin_connection_requests_today": 0,
"linkedin_identity": "<string>",
"linkedin_photo_url": "<string>",
"linkedin_presence": "active",
"sent_today": 0,
"signature_text": ""
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Update a sender
curl --request PATCH \
--url https://api.getoneprofile.ai/sender-profiles/{profile_id}/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"booking_url": "<string>",
"confirm": false,
"first_name": "<string>",
"last_name": "<string>",
"signature_text": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/sender-profiles/{profile_id}/"
payload = {
"booking_url": "<string>",
"confirm": False,
"first_name": "<string>",
"last_name": "<string>",
"signature_text": "<string>",
"title": "<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({
booking_url: '<string>',
confirm: false,
first_name: '<string>',
last_name: '<string>',
signature_text: '<string>',
title: '<string>'
})
};
fetch('https://api.getoneprofile.ai/sender-profiles/{profile_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.getoneprofile.ai/sender-profiles/{profile_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([
'booking_url' => '<string>',
'confirm' => false,
'first_name' => '<string>',
'last_name' => '<string>',
'signature_text' => '<string>',
'title' => '<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.getoneprofile.ai/sender-profiles/{profile_id}/"
payload := strings.NewReader("{\n \"booking_url\": \"<string>\",\n \"confirm\": false,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"signature_text\": \"<string>\",\n \"title\": \"<string>\"\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.getoneprofile.ai/sender-profiles/{profile_id}/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"booking_url\": \"<string>\",\n \"confirm\": false,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"signature_text\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/sender-profiles/{profile_id}/")
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 \"booking_url\": \"<string>\",\n \"confirm\": false,\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"signature_text\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"booking_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailbox_count": 123,
"name": "<string>",
"send_mode": "always_send",
"status": "draft",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"daily_limit": 0,
"email_approval_mode": "manual",
"first_name": "",
"last_name": "",
"linkedin_connection_request_cap": 0,
"linkedin_connection_requests_today": 0,
"linkedin_identity": "<string>",
"linkedin_photo_url": "<string>",
"linkedin_presence": "active",
"sent_today": 0,
"signature_text": ""
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Path Parameters
Body
A field omitted from the request is left unchanged.
The link people use to book a meeting with this sender. It has to be a full web address starting with http:// or https://. Null or an empty string removes it. Only a person signed in to Oneprofile can change it.
2048Set to true to confirm that this sender's messages may go out without anyone reading them first. Required when send_mode is always_send; ignored otherwise.
Whether a sender's email steps wait in the approval queue or send on their own.
F-25's per-sender override of the workspace's email approval mode. The
workspace setting lives in the outreach-task domain, a layer above this
one, so this enum names only the two overrides a sender can carry; the
absence of one (SenderProfileDTO.email_approval_mode is None) means
the sender follows the workspace.
manual, auto 1 - 128128How much of this sender's agent-written email leaves without a person.
ALWAYS_SEND: agent-written email steps and replies go out unattended
unless a defect is found in the message itself. SEND_WHEN_CONFIDENT:
they go out when the agent's confidence rule holds, and a person is asked
when it does not. ALWAYS_ASK: every agent-written email waits for a
person, whatever the agent thinks of it.
The three are ordered by strictness — ALWAYS_ASK strictest, then
SEND_WHEN_CONFIDENT, then ALWAYS_SEND loosest — and that order is what
service.strictest_send_mode folds a cadence's assigned senders down
with. The order is the point: everything that combines two modes must
resolve towards asking, never towards sending.
Replaces EmailApprovalMode's two-way choice, which cannot express
"send the ones the agent stands behind". That enum and its column stay
until a release backfills this one; do not read both in one decision.
always_send, send_when_confident, always_ask Plain-text signature appended to every send.
The sender's job title, one line of up to 120 characters, as their messages introduce them. An empty string removes it. Only a person signed in to Oneprofile can change it.
120Response
Successful Response
The link people use to book a meeting with this sender, such as a Calendly or Cal.com page. It is what the {{Sender booking link}} variable is replaced with. Null when none is set.
Whether the messages the agent writes for this sender go out on their own or wait for a person, replies included. Always send (always_send): the agent's messages go out on their own unless something is wrong with the words. Send when confident (send_when_confident, the default): they go out when the agent was confident and nothing is wrong, and wait for a person otherwise. Always ask (always_ask): a person approves every one. A sequence set to ask first still asks, whichever mode its senders are on.
always_send, send_when_confident, always_ask Lifecycle of a sender.
A sender is DRAFT from the moment it is created and becomes ACTIVE once at least one mailbox is attached. The status is derived from attachment, never stored — it cannot drift.
draft, active The sender's job title, as their messages introduce them. It is what the {{Sender title}} variable is replaced with. Empty when none is set.
manual | auto; null inherits the workspace's email approval mode.
manual, auto How recently ANY browser connected to this sender checked in.
Three states, not two, because two different questions are asked of a
connection. ACTIVE answers "can a step run right now" — a browser is
open and heartbeating. IDLE answers "is this still set up" — the laptop
was closed for the evening. NOT_SEEN is the one that needs a person:
nothing has checked in for a day, and queued work is silently waiting.
active, idle, not_seen Was this page helpful?