NamespaceResp

  • key
    Type: string
    required

    Canonical, immutable identifier for the namespace within the organization. Lowercase alphanumeric with optional hyphens, customer-supplied at create time, unique per organization. Cannot be changed.

  • mode
    Type: string enum
    required

    Billing classification for the namespace. test is for any non-production usage — dev, staging, QA, integration testing — and is not billed. live is for production traffic and is billed. The label is a billing/safety boundary, not an environment label: you can run any number of test namespaces (e.g. one per developer, one for staging, one for CI) and any number of live namespaces (e.g. one per product or tenant). Fixed at create time and immutable. The mode propagates to API keys minted under this namespace and to every webhook delivery's mode field, so test data can never reach a live integration and vice versa.

    values
    • test
    • live
  • name
    Type: string
    required

    Human-readable display name. Shown in Studio's namespace switcher and on customer-facing surfaces. Editable via PUT.

  • timezone
    Type: string
    required

    IANA timezone name used to render dates in this namespace's documents when a JSONata expression does not name a zone explicitly.

    Always present. Resolution order: an explicit zone argument in the expression wins, then the workflow's own timezone (options.timezone on POST /workflows, which defaults to this), then this. Set when the namespace is created — Studio pre-fills the browser's zone — and cannot be cleared.

    Must be a Region/City IANA name, or UTC. Ambiguous abbreviations (EST, PST) and fixed-offset zones (Etc/GMT+8) are rejected, because they do not observe daylight saving and would render dates an hour out for part of the year.

  • createdAt
    Type: string Format: date-time

    ISO 8601 / RFC 3339 timestamp of namespace creation.

  • settings
    Type: object · BrandSettings

    Brand configuration (sender name, logo, contact email) applied to customer-facing surfaces such as outbound emails and signing pages. Editable wholesale via PATCH.

    • company
      Type: string
      required

      Company name shown in branded headers, footers, and signing pages.

    • contactEmail
      Type: string Format: email
      required

      Reply-to / support contact email shown to recipients of branded communications.

    • logoFileId
      Type: string
      required

      ID of the logo file. Upload the asset first via POST .../files/upload-url and pass the returned fileId here. Fetch the bytes via the files endpoint when you need to render the logo.

    • senderName
      Type: string
      required

      Display name shown as the sender on outbound emails (e.g. "Acme Corp HR").

    • address
      Type: string

      Optional postal address for the brand. Shown in email footers where required for compliance (e.g. CAN-SPAM).

    • phone
      Type: string

      Optional contact phone number shown alongside contactEmail on branded surfaces.

    • senderEmail
      Type: string Format: email

      From-address used on outbound emails. Must be on a verified sending domain — see senderEmailVerified.

    • senderEmailVerified
      Type: boolean
      read-only

      Whether senderEmail has passed domain verification. Response-only — set by the verification flow, not by PATCH. Outbound emails fall back to a default sender when false.

  • updatedAt
    Type: string Format: date-time

    ISO 8601 / RFC 3339 timestamp of the most recent modification. Drives the ETag value used for optimistic concurrency on PATCH.