Rename Sender Profile

PATCH

api

sender-profiles

{id}

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/sender-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sender-profiles/{id}"

payload = { "name": "<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>'})
};

fetch('https://api.sequenzy.com/api/v1/sender-profiles/{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.sequenzy.com/api/v1/sender-profiles/{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([
    'name' => '<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://api.sequenzy.com/api/v1/sender-profiles/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\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://api.sequenzy.com/api/v1/sender-profiles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "senderProfile": {
    "id": "sender_abc123",
    "name": "SnapCount",
    "email": "hello@snapcount.app",
    "domain": "snapcount.app",
    "domainStatus": "verified",
    "canSend": true,
    "isDefault": true
  },
  "renamed": true
}

{
  "error": "name cannot be empty."
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: companies:manage"
}

{
  "error": "Sender profile not found"
}

{
  "error": "Another sender identity for hello@snapcount.app is already named \"SnapCount\" (sender_def456). Rename or remove that one first, or point your campaigns at it instead."
}

Rename one sender (From) profile in place. Only the display name changes: the address, its sending domain, and the account-wide default From selection are left exactly as they were. Use this to standardize a display name across the several identities one mailbox may carry - for example, consolidating Viraj from SnapCount down to SnapCount. Campaigns and sequences pinned to this profile pick up the new name on their next send.

To change which profile is the account default, use Update Company with senderProfileId instead. That endpoint renames and promotes in one step; this one never touches the default.

Get profile IDs from List Sender Profiles. Requires the companies:manage scope.

Request

string

required

Sender profile ID.

string

required

New display name. Trimmed before saving; must be non-empty and 255 characters or fewer.

curl -X PATCH "https://api.sequenzy.com/api/v1/sender-profiles/sender_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "SnapCount"}'

Response fields

boolean

false when the profile already carried that name, so nothing changed. Lets a retried call report accurately instead of claiming a change that never happened.

boolean

Whether this profile is the account default. This endpoint never changes it.

Responses

{
  "success": true,
  "senderProfile": {
    "id": "sender_abc123",
    "name": "SnapCount",
    "email": "hello@snapcount.app",
    "domain": "snapcount.app",
    "domainStatus": "verified",
    "canSend": true,
    "isDefault": true
  },
  "renamed": true
}

{
  "error": "name cannot be empty."
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: companies:manage"
}

{
  "error": "Sender profile not found"
}

{
  "error": "Another sender identity for hello@snapcount.app is already named \"SnapCount\" (sender_def456). Rename or remove that one first, or point your campaigns at it instead."
}

Rename Reply-To ProfileRename a reply-to profile without changing account defaults

Rename Sender Profile

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/sender-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sender-profiles/{id}"

payload = { "name": "<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>'})
};

fetch('https://api.sequenzy.com/api/v1/sender-profiles/{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.sequenzy.com/api/v1/sender-profiles/{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([
    'name' => '<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://api.sequenzy.com/api/v1/sender-profiles/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\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://api.sequenzy.com/api/v1/sender-profiles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "senderProfile": {
    "id": "sender_abc123",
    "name": "SnapCount",
    "email": "hello@snapcount.app",
    "domain": "snapcount.app",
    "domainStatus": "verified",
    "canSend": true,
    "isDefault": true
  },
  "renamed": true
}

{
  "error": "name cannot be empty."
}

{
  "error": "Unauthorized"
}

{
  "error": "API key is missing required scope: companies:manage"
}

{
  "error": "Sender profile not found"
}

{
  "error": "Another sender identity for hello@snapcount.app is already named \"SnapCount\" (sender_def456). Rename or remove that one first, or point your campaigns at it instead."
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Notification Preferences

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Rename Sender Profile

Request

Response fields

Responses

​Request

​Response fields

​Responses

Request

Response fields

Responses