OrganizationResp

Full organization — returned by POST /orgs and PUT /orgs/{orgId}. The optimistic-locking handle is returned in the HTTP ETag response header (RFC 7232) — capture it from the response and pass it back as If-Match on the next PUT.

  • name
    Type: string
    required

    Display name.

  • orgId
    Type: string Pattern: ^org_[0-9a-z]{26}$
    required

    Organization ID. Stable for the life of the org. Prefixed lowercase ULID, e.g. org_01jv8m7qfj6xj9gkz7a4s2h8e.

  • ownerId
    Type: string
    required

    UID of the organization owner.

  • updatedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • settings
    Type: object · BrandSettings

    Brand / sender settings used in transactional email.

    • company
      Type: string
      required

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

    • contactEmail
      Type: stringFormat: 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: stringFormat: 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.