v93

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB

Companies

Update company

Updates product info, brand context, the default email theme, reply-tracking settings, and account-wide From/Reply-To defaults. New profiles are created as needed; From addresses require a verified sending domain.

patch/companies/{companyId}

Path parameters

companyIdstring required

Company ID

Request body

namestring

descriptionstring nullable

logoUrlstring nullable

founderNamestring nullable

primaryColorstring

6-digit hex color, for example

brandColorsobject nullable

valuePropsobject[] nullable

testimonialsobject[] nullable

toneVoicestring nullable

companyContextstring nullable

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

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.

replyTrackingDomainMode'sequenzy' | 'custom'

Use Sequenzy's managed inbound domain or a configured custom domain.

forwardRepliesboolean

Enable or disable forwarding captured replies to the configured mailbox.

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",
    "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.",
    "emailLengthPreference": "balanced",
    "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"
  }
}