Companies

Update company

Changed on

Updates product info, brand context, the default email theme, reply-tracking settings, the workspace default lists, and account-wide From/Reply-To defaults. New profiles are created as needed; From addresses require a verified sending domain. Requires the company_profile:manage scope; the sending-identity, reply-tracking, and defaultSubscriberListIds fields additionally require companies:manage.

patch/companies/{companyId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/companies/{companyId}
  • Auth
    HTTP bearer

Path parameters

companyIdstring required

Company ID

Request body

renameMatchingFootersboolean

With name and previousCompanyName, atomically rename exact matching footer company names in editable emails and saved components. Preserves custom names, body copy, sent or sending campaigns and active A/B tests. Null is not accepted. This option additionally requires emails:write, templates:write, campaigns:write, sequences:write, transactional:write and ab_tests:write; personal keys require owner/admin access.

previousCompanyNamestring

Required when renameMatchingFooters is true. Current company name from GET company. A stale name returns 409; retrying a completed rename does not repeat footer changes.

namestring
descriptionstring nullable
logoUrlstring nullable
darkModeLogoUrlstring nullable

Your own dark-mode version of the logo. Every email uses it instead of the automatic outlined copy, in light and dark inboxes, so it must read on both. Requires a logo (here or already saved); changing the logo later drops it. Send null to go back to the automatic one.

founderNamestring nullable
primaryColorstring

6-digit hex color, for example

brandColorsobject nullable
valuePropsobject[] nullable
testimonialsobject[] nullable
toneVoicestring nullable
companyContextstring nullable
emailDesignPromptstring nullable

Art direction for AI-designed emails: layout, density, which sections belong in an email, imagery, and CTA prominence. toneVoice steers copy; this steers design. When empty, the next email generation prefills it with the direction derived from the brand; null clears it so the next generation writes a fresh one.

emailLengthPreference'concise' | 'balanced' | 'detailed'

How long AI-written email copy should be. New workspaces default to concise.

emailStylePreference'visual' | 'plain' | 'null' nullable

How AI writes emails by default: visual for designed emails, plain for simple text-focused emails. null clears the choice, so generation designs emails and the dashboard asks again. Other strings return 400; values that are not a string or null return 422.

emailPreset'branded' | 'minimal'

Default header and footer for new emails: branded (logo header and full footer) or minimal (compact footer, no logo). Existing emails keep their own setting. While a saved reference email exists, AI-generated emails use its header and footer instead until it is cleared. Other strings return 400; values that are not a string return 422.

footerStyle'auto' | 'classic' | 'mono' | 'band' | 'editorial'

Footer style for new AI-designed emails: auto (fits the brand), classic, mono, band or editorial. Kept in the stored footer theme, alongside its other settings. Existing emails keep their footers. Other values return 400.

socialLinksobject nullable
privacyPolicyUrlstring nullable
termsUrlstring nullable
addressstring nullable
languagestring
pricingobject nullable
fontFamilystring nullable
emailDirection'ltr' | 'rtl'
senderProfileIdstring

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.

fromEmailstring email

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

fromNamestring

Display name of the default From profile. Sent on its own it renames the current default profile; 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.

replyProfileIdstring

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

replyTostring email

Account-wide default Reply-To address. A reply profile is created when needed.

replyToNamestring

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

replyTrackingEnabledboolean

Enable or disable inbound reply capture (Inbox). Turning it on needs a verified receiving domain unless the workspace has received conversations before; otherwise the request fails with 409 receiving_domain_required. The first verification of a receiving domain you added turns it on automatically.

replyTrackingDomainMode'sequenzy' | 'custom'

custom points reply addresses at your verified receiving domain for emails from every sending domain, falling back to inbound.sequenzy.com until one is verified; sequenzy always uses inbound.sequenzy.com.

forwardRepliesboolean

Enable or disable forwarding captured replies to the configured mailbox.

defaultSubscriberListIdsstring[] nullable

Which lists new contacts join when something creates a subscriber without explicit list targeting - forms, API writes, events, tag actions, imports, and any integration without its own list targeting. null means every current and future list, [] means no list at all, and an array means exactly those lists. Unknown or foreign list IDs are rejected rather than skipped. Applies only to later writes; nobody is moved or removed retroactively. Requires the companies:manage scope.

Response

Company updated

successboolean

Example response

{
  "success": true,
  "company": {
    "id": "company_abc123",
    "name": "Acme Inc",
    "description": "Lifecycle email automation for SaaS teams.",
    "status": "ready",
    "websiteUrl": "acme.com",
    "logoUrl": "https://example.com/logo.png",
    "darkModeLogoStatus": "not_needed",
    "founderName": "Sarah",
    "primaryColor": "#0ea5e9",
    "brandColors": {
      "primary": "#0ea5e9"
    },
    "valueProps": [
      {
        "title": "Fast setup",
        "description": "Launch lifecycle emails in minutes."
      }
    ],
    "toneVoice": "clear, direct, warm",
    "companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
    "emailDesignPrompt": "Editorial and calm. One idea per email, no feature grids.",
    "emailLengthPreference": "concise",
    "emailStylePreference": "visual",
    "emailPreset": "branded",
    "footerStyle": "auto",
    "url": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123",
    "previewUrl": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123?step=review",
    "language": "en",
    "emailDirection": "ltr",
    "defaultSubscriberListIds": [
      "list_abc123"
    ]
  }
}

Changes

  • e2e7d27d7804Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 62f1bc53cfd2Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status