Companies

Create company

Changed on

Creates a company workspace, optionally without a website, and can queue the onboarding welcome sequence. Requires a personal account key (seq_user_...). Company-scoped keys (seq_live_... and legacy ek_... keys) are bound to a single company and are rejected with 403, because they could never access the workspace they created.

post/companies

Request

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

Request body

namestring

Company display name. If omitted, Sequenzy derives it from the domain.

domainstring

Company website domain or URL. Required unless noWebsite is true. When both are sent, the domain is used.

noWebsiteboolean

Create a ready workspace without a website. Requires name when no domain is sent. Ignored when a non-blank domain is sent.

descriptionstring

Optional business description used as context for welcome-sequence generation. Without a website, a non-null value that is not a string of up to 500 characters returns 400; with a domain it is ignored, and website processing may replace the stored description.

withWelcomeSequenceboolean

Set true to create a draft four-email welcome sequence and queue its generation. Defaults to false; any other value is treated as false.

Response

Company created

successboolean
welcomeAutomationIdstring nullable
welcomeEnrichmentJobIdstring nullable
messagestring

Example response

{
  "success": true
}

Changes

  • db3873ca3d4dRevision changes
    • breaking

      the response property / became nullable for the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status