Skip to main content
PUT
/
api
/
v1
/
sender-profiles
/
{profile_id}
Update Sender Profile
curl --request PUT \
  --url https://api.example.com/api/v1/sender-profiles/{profile_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "profile_name": "<string>",
  "description": "<string>",
  "sender_data": {},
  "is_default": true
}
'
import requests

url = "https://api.example.com/api/v1/sender-profiles/{profile_id}"

payload = {
    "profile_name": "<string>",
    "description": "<string>",
    "sender_data": {},
    "is_default": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    profile_name: '<string>',
    description: '<string>',
    sender_data: {},
    is_default: true
  })
};

fetch('https://api.example.com/api/v1/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.example.com/api/v1/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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'profile_name' => '<string>',
    'description' => '<string>',
    'sender_data' => [
        
    ],
    'is_default' => true
  ]),
  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://api.example.com/api/v1/sender-profiles/{profile_id}"

	payload := strings.NewReader("{\n  \"profile_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sender_data\": {},\n  \"is_default\": true\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/v1/sender-profiles/{profile_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"profile_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sender_data\": {},\n  \"is_default\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/sender-profiles/{profile_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"profile_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sender_data\": {},\n  \"is_default\": true\n}"

response = http.request(request)
puts response.read_body
{
  "user_id": "<string>",
  "profile_name": "<string>",
  "sender_data": {
    "data": {}
  },
  "id": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "usage_count": 0,
  "is_default": false
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

profile_id
string
required

Body

application/json

Request model for updating a sender profile.

profile_name
string | null

New name for the profile

Required string length: 1 - 100
description
string | null

New description

Maximum string length: 500
sender_data
Sender Data · object | null

New sender data (replaces existing data completely)

is_default
boolean | null

Whether this should be the default profile

Response

Successful Response

Sender profile model for storing reusable sender configurations.

This model stores a named profile containing DynamicSenderData, which can have ANY arbitrary fields. There is no predefined schema for the sender data.

Examples of valid sender data:

  • {"full_name": "John", "company": "TechCorp", "role": "Sales"}
  • {"sender_name": "Jane", "brand": "AI Solutions", "linkedin": "jane-doe"}
  • {"name": "Bob", "agency": "Marketing Pro", "phone": "+1234", "timezone": "EST"}
  • Any other combination of fields the user needs
user_id
string
required

User ID who owns this profile

profile_name
string
required

User-friendly name for this profile (e.g., 'Sales Team Profile', 'Personal Brand')

Required string length: 1 - 100
sender_data
DynamicSenderData · object
required

The actual sender data with arbitrary fields

id
string | null

Unique profile identifier

description
string | null

Optional description of when/how to use this profile

Maximum string length: 500
created_at
string<date-time> | null

Profile creation timestamp

updated_at
string<date-time> | null

Last update timestamp

usage_count
integer
default:0

Number of times this profile has been used

is_default
boolean
default:false

Whether this is the default profile