OrganizationListItem

  • 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
      required

      Organization ID. Stable for the life of the org.

    • 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

    • _eTag
      Type: string

      Optimistic-locking handle for this organization. Carried in the body on list items because list responses can't multiplex per-item ETag headers. Pass back as If-Match on the next PUT.

    • settings
      Type: object

      Brand / sender settings used in transactional email.