Update Company

PATCH

api

companies

{companyId}

Update Company

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/companies/{companyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primaryColor": "<string>",
  "emailTheme": {},
  "description": "<string>",
  "companyContext": "<string>",
  "toneVoice": "<string>",
  "valueProps": [
    {}
  ],
  "senderProfileId": "<string>",
  "fromEmail": "<string>",
  "fromName": "<string>",
  "replyProfileId": "<string>",
  "replyTo": "<string>",
  "replyToName": "<string>",
  "replyTrackingEnabled": true,
  "replyTrackingDomainMode": "<string>",
  "forwardReplies": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/companies/{companyId}"

payload = {
    "primaryColor": "<string>",
    "emailTheme": {},
    "description": "<string>",
    "companyContext": "<string>",
    "toneVoice": "<string>",
    "valueProps": [{}],
    "senderProfileId": "<string>",
    "fromEmail": "<string>",
    "fromName": "<string>",
    "replyProfileId": "<string>",
    "replyTo": "<string>",
    "replyToName": "<string>",
    "replyTrackingEnabled": True,
    "replyTrackingDomainMode": "<string>",
    "forwardReplies": True
}
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({
    primaryColor: '<string>',
    emailTheme: {},
    description: '<string>',
    companyContext: '<string>',
    toneVoice: '<string>',
    valueProps: [{}],
    senderProfileId: '<string>',
    fromEmail: '<string>',
    fromName: '<string>',
    replyProfileId: '<string>',
    replyTo: '<string>',
    replyToName: '<string>',
    replyTrackingEnabled: true,
    replyTrackingDomainMode: '<string>',
    forwardReplies: true
  })
};

fetch('https://api.sequenzy.com/api/v1/companies/{companyId}', 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/companies/{companyId}",
  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([
    'primaryColor' => '<string>',
    'emailTheme' => [
        
    ],
    'description' => '<string>',
    'companyContext' => '<string>',
    'toneVoice' => '<string>',
    'valueProps' => [
        [
                
        ]
    ],
    'senderProfileId' => '<string>',
    'fromEmail' => '<string>',
    'fromName' => '<string>',
    'replyProfileId' => '<string>',
    'replyTo' => '<string>',
    'replyToName' => '<string>',
    'replyTrackingEnabled' => true,
    'replyTrackingDomainMode' => '<string>',
    'forwardReplies' => 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.sequenzy.com/api/v1/companies/{companyId}"

	payload := strings.NewReader("{\n  \"primaryColor\": \"<string>\",\n  \"emailTheme\": {},\n  \"description\": \"<string>\",\n  \"companyContext\": \"<string>\",\n  \"toneVoice\": \"<string>\",\n  \"valueProps\": [\n    {}\n  ],\n  \"senderProfileId\": \"<string>\",\n  \"fromEmail\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyProfileId\": \"<string>\",\n  \"replyTo\": \"<string>\",\n  \"replyToName\": \"<string>\",\n  \"replyTrackingEnabled\": true,\n  \"replyTrackingDomainMode\": \"<string>\",\n  \"forwardReplies\": true\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/companies/{companyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"primaryColor\": \"<string>\",\n  \"emailTheme\": {},\n  \"description\": \"<string>\",\n  \"companyContext\": \"<string>\",\n  \"toneVoice\": \"<string>\",\n  \"valueProps\": [\n    {}\n  ],\n  \"senderProfileId\": \"<string>\",\n  \"fromEmail\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyProfileId\": \"<string>\",\n  \"replyTo\": \"<string>\",\n  \"replyToName\": \"<string>\",\n  \"replyTrackingEnabled\": true,\n  \"replyTrackingDomainMode\": \"<string>\",\n  \"forwardReplies\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/companies/{companyId}")

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  \"primaryColor\": \"<string>\",\n  \"emailTheme\": {},\n  \"description\": \"<string>\",\n  \"companyContext\": \"<string>\",\n  \"toneVoice\": \"<string>\",\n  \"valueProps\": [\n    {}\n  ],\n  \"senderProfileId\": \"<string>\",\n  \"fromEmail\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyProfileId\": \"<string>\",\n  \"replyTo\": \"<string>\",\n  \"replyToName\": \"<string>\",\n  \"replyTrackingEnabled\": true,\n  \"replyTrackingDomainMode\": \"<string>\",\n  \"forwardReplies\": true\n}"

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

{
  "success": true,
  "company": {
    "id": "company_abc123",
    "name": "Acme",
    "primaryColor": "#0ea5e9",
    "brandColors": { "primary": "#0ea5e9" },
    "companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
    "toneVoice": "clear, direct, warm",
    "emailLengthPreference": "concise",
    "defaultSenderProfileId": "sender_abc123",
    "defaultFromName": "Acme",
    "defaultFromEmail": "hello@acme.com",
    "defaultReplyProfileId": "reply_abc123",
    "defaultReplyToName": "Acme Support",
    "defaultReplyToEmail": "support@acme.com",
    "replyTrackingEnabled": true,
    "replyTrackingDomainMode": "sequenzy",
    "forwardReplies": true,
    "replyRetentionDays": 30
  }
}

{
  "success": false,
  "error": "primaryColor must be a 6-digit hex color such as #f97316."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: companies:manage. It is required to change account-wide sending defaults: fromEmail. Update the remaining workspace profile fields on their own, or retry with a broader key."
}

{
  "success": false,
  "error": "Company not found"
}

Update company product info, brand context, reply-tracking settings, and account-wide From and Reply-To defaults. A new profile is created when an address does not already have one. From addresses must use a configured, verified sending domain; Reply-To addresses may use any valid mailbox. The current read-only retention period is returned as replyRetentionDays by the company endpoints. Requires the company_profile:manage scope. The sending-identity and reply-tracking fields (senderProfileId, fromEmail, fromName, replyProfileId, replyTo, replyToName, replyTrackingEnabled, replyTrackingDomainMode, forwardReplies) additionally require companies:manage; a request that mixes them with profile fields is rejected as a whole rather than partially applied. Keys that already hold companies:manage satisfy company_profile:manage automatically.

Request

string

required

Company ID.

string

Primary brand color as a 6-digit hex value, for example #0ea5e9. Also updates the email theme’s primary color unless emailTheme sets one explicitly.

object | null

Default email theme applied to campaigns, sequences, and transactional email. Partial update: omitted fields keep their current value (or the preset default), and numeric values are clamped to supported ranges. Pass null to reset to the platform default theme. Supported fields:

presetId: default, soft, editorial, or bold
colors: 6-digit hex values for primary, background, surface, text, mutedText, heading, border, link
typography: numbers for baseFontSize, leadFontSize, baseLineHeight, heading1Size, heading2Size, heading3Size, buttonFontSize
layout: numbers for contentWidth, containerPaddingX, containerPaddingY, blockSpacing, baseRadius, sectionPadding, buttonPaddingX, buttonPaddingY, borderedBlockPadding

The auto-appended unsubscribe footer has its own colors stored under brandColors.footerTheme (backgroundColor, companyTextColor, metaTextColor, linkColor, borderColor). When changing them via brandColors, send the merged object - the field is replaced wholesale.

string

Short product or company summary.

string

Basic product/company knowledge AI should use when writing emails.

string

Tone of voice guidance for generated copy.

array

Value propositions, usually objects with title and description.

string

Existing sender profile to make the account-wide default, and the profile fromName renames. List IDs with GET /v1/sender-profiles. Mutually exclusive with fromEmail.

string

Account-wide default From address. Its domain must already be configured and verified.

string

Display name of the default From profile. Sent on its own it renames the current default profile without changing its address; with senderProfileId it renames that profile; with fromEmail it names the profile for that address. If the address already carries several display names, the request is rejected - pass senderProfileId to say which one to rename.

string

Existing reply profile to make the account-wide default, and the profile replyToName renames. Mutually exclusive with replyTo.

string

Account-wide default Reply-To address.

string

Display name of the default Reply-To profile. Sent on its own it renames the current default profile without changing its address; with replyProfileId it renames that profile; with replyTo it names the profile for that address.

boolean

Enable or disable inbound reply capture for this company.

string

Reply domain mode: sequenzy for the managed inbound domain or custom for a configured custom domain.

boolean

Enable or disable forwarding captured replies to the configured mailbox.

curl -X PATCH "https://api.sequenzy.com/api/v1/companies/company_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "primaryColor": "#0ea5e9",
    "emailTheme": {
      "colors": { "mutedText": "#4b5563" },
      "typography": { "baseFontSize": 16 }
    },
    "companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
    "toneVoice": "clear, direct, warm",
    "fromEmail": "hello@acme.com",
    "fromName": "Acme",
    "replyTo": "support@acme.com",
    "replyToName": "Acme Support",
    "replyTrackingEnabled": true,
    "replyTrackingDomainMode": "sequenzy",
    "forwardReplies": true
  }'

Responses

{
  "success": true,
  "company": {
    "id": "company_abc123",
    "name": "Acme",
    "primaryColor": "#0ea5e9",
    "brandColors": { "primary": "#0ea5e9" },
    "companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
    "toneVoice": "clear, direct, warm",
    "emailLengthPreference": "concise",
    "defaultSenderProfileId": "sender_abc123",
    "defaultFromName": "Acme",
    "defaultFromEmail": "hello@acme.com",
    "defaultReplyProfileId": "reply_abc123",
    "defaultReplyToName": "Acme Support",
    "defaultReplyToEmail": "support@acme.com",
    "replyTrackingEnabled": true,
    "replyTrackingDomainMode": "sequenzy",
    "forwardReplies": true,
    "replyRetentionDays": 30
  }
}

{
  "success": false,
  "error": "primaryColor must be a 6-digit hex color such as #f97316."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: companies:manage. It is required to change account-wide sending defaults: fromEmail. Update the remaining workspace profile fields on their own, or retry with a broader key."
}

{
  "success": false,
  "error": "Company not found"
}

Update Company

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/companies/{companyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primaryColor": "<string>",
  "emailTheme": {},
  "description": "<string>",
  "companyContext": "<string>",
  "toneVoice": "<string>",
  "valueProps": [
    {}
  ],
  "senderProfileId": "<string>",
  "fromEmail": "<string>",
  "fromName": "<string>",
  "replyProfileId": "<string>",
  "replyTo": "<string>",
  "replyToName": "<string>",
  "replyTrackingEnabled": true,
  "replyTrackingDomainMode": "<string>",
  "forwardReplies": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/companies/{companyId}"

payload = {
    "primaryColor": "<string>",
    "emailTheme": {},
    "description": "<string>",
    "companyContext": "<string>",
    "toneVoice": "<string>",
    "valueProps": [{}],
    "senderProfileId": "<string>",
    "fromEmail": "<string>",
    "fromName": "<string>",
    "replyProfileId": "<string>",
    "replyTo": "<string>",
    "replyToName": "<string>",
    "replyTrackingEnabled": True,
    "replyTrackingDomainMode": "<string>",
    "forwardReplies": True
}
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({
    primaryColor: '<string>',
    emailTheme: {},
    description: '<string>',
    companyContext: '<string>',
    toneVoice: '<string>',
    valueProps: [{}],
    senderProfileId: '<string>',
    fromEmail: '<string>',
    fromName: '<string>',
    replyProfileId: '<string>',
    replyTo: '<string>',
    replyToName: '<string>',
    replyTrackingEnabled: true,
    replyTrackingDomainMode: '<string>',
    forwardReplies: true
  })
};

fetch('https://api.sequenzy.com/api/v1/companies/{companyId}', 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/companies/{companyId}",
  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([
    'primaryColor' => '<string>',
    'emailTheme' => [
        
    ],
    'description' => '<string>',
    'companyContext' => '<string>',
    'toneVoice' => '<string>',
    'valueProps' => [
        [
                
        ]
    ],
    'senderProfileId' => '<string>',
    'fromEmail' => '<string>',
    'fromName' => '<string>',
    'replyProfileId' => '<string>',
    'replyTo' => '<string>',
    'replyToName' => '<string>',
    'replyTrackingEnabled' => true,
    'replyTrackingDomainMode' => '<string>',
    'forwardReplies' => 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.sequenzy.com/api/v1/companies/{companyId}"

	payload := strings.NewReader("{\n  \"primaryColor\": \"<string>\",\n  \"emailTheme\": {},\n  \"description\": \"<string>\",\n  \"companyContext\": \"<string>\",\n  \"toneVoice\": \"<string>\",\n  \"valueProps\": [\n    {}\n  ],\n  \"senderProfileId\": \"<string>\",\n  \"fromEmail\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyProfileId\": \"<string>\",\n  \"replyTo\": \"<string>\",\n  \"replyToName\": \"<string>\",\n  \"replyTrackingEnabled\": true,\n  \"replyTrackingDomainMode\": \"<string>\",\n  \"forwardReplies\": true\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/companies/{companyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"primaryColor\": \"<string>\",\n  \"emailTheme\": {},\n  \"description\": \"<string>\",\n  \"companyContext\": \"<string>\",\n  \"toneVoice\": \"<string>\",\n  \"valueProps\": [\n    {}\n  ],\n  \"senderProfileId\": \"<string>\",\n  \"fromEmail\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyProfileId\": \"<string>\",\n  \"replyTo\": \"<string>\",\n  \"replyToName\": \"<string>\",\n  \"replyTrackingEnabled\": true,\n  \"replyTrackingDomainMode\": \"<string>\",\n  \"forwardReplies\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/companies/{companyId}")

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  \"primaryColor\": \"<string>\",\n  \"emailTheme\": {},\n  \"description\": \"<string>\",\n  \"companyContext\": \"<string>\",\n  \"toneVoice\": \"<string>\",\n  \"valueProps\": [\n    {}\n  ],\n  \"senderProfileId\": \"<string>\",\n  \"fromEmail\": \"<string>\",\n  \"fromName\": \"<string>\",\n  \"replyProfileId\": \"<string>\",\n  \"replyTo\": \"<string>\",\n  \"replyToName\": \"<string>\",\n  \"replyTrackingEnabled\": true,\n  \"replyTrackingDomainMode\": \"<string>\",\n  \"forwardReplies\": true\n}"

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

{
  "success": true,
  "company": {
    "id": "company_abc123",
    "name": "Acme",
    "primaryColor": "#0ea5e9",
    "brandColors": { "primary": "#0ea5e9" },
    "companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
    "toneVoice": "clear, direct, warm",
    "emailLengthPreference": "concise",
    "defaultSenderProfileId": "sender_abc123",
    "defaultFromName": "Acme",
    "defaultFromEmail": "hello@acme.com",
    "defaultReplyProfileId": "reply_abc123",
    "defaultReplyToName": "Acme Support",
    "defaultReplyToEmail": "support@acme.com",
    "replyTrackingEnabled": true,
    "replyTrackingDomainMode": "sequenzy",
    "forwardReplies": true,
    "replyRetentionDays": 30
  }
}

{
  "success": false,
  "error": "primaryColor must be a 6-digit hex color such as #f97316."
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: companies:manage. It is required to change account-wide sending defaults: fromEmail. Update the remaining workspace profile fields on their own, or retry with a broader key."
}

{
  "success": false,
  "error": "Company not found"
}

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Sending Status

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

Request

Responses

​Request

​Responses

Request

Responses