{ "openapi": "3.0.3", "info": { "title": "Organization API", "description": "The Organization API provides endpoints for managing epilot tenant organizations.\n\n## Overview\n\nThis API allows you to:\n- **Retrieve organization details** - Get information about the current organization or a specific organization by ID\n- **Update organization profiles** - Modify organization name, contact information, address, and branding assets\n- **Manage organization settings** - Configure organization-wide settings such as feature flags and preferences\n- **Branding configuration** - Set organization logos, email signatures, and style settings\n\n## Organization Types\n\nOrganizations can be configured as:\n- **Production** - Live production environments for real business operations\n- **Sandbox** - Test environments linked to a parent production organization\n- **Preview** - Temporary copies of a production organization, used to preview configuration changes\n", "version": "1.1.0" }, "tags": [ { "name": "Organization", "description": "Endpoints for managing organization profiles and information.\n\nOrganizations represent tenant accounts in the epilot platform. Each organization has:\n- Basic profile information (name, contact details, address)\n- Branding assets (logo, email signature)\n- Configuration settings\n- Usage type (Production, Sandbox or Preview)\n" }, { "name": "Organization Settings", "description": "Endpoints for managing organization-wide configuration settings.\n\nSettings are stored as key-value pairs and can include:\n- Feature flags (e.g., double_opt_in)\n- Integration configurations\n- Platform preferences\n\nSettings values can be strings, numbers, booleans, arrays, or objects.\n" }, { "name": "Feature Settings", "description": "Feature flag metadata for the organization settings page.\n\nThis metadata is used by frontend applications to render feature toggles\nwithout hardcoding titles, descriptions, badges, and visibility rules in the UI.\n" }, { "name": "Announcements", "description": "Platform announcements shown as a non-blocking portal banner, e.g. subprocessor change notices.\n\nAnnouncements are managed internally (admin portal) and acknowledged by organization admins.\nEach organization acknowledges an announcement at most once (first acknowledgement wins).\n" } ], "security": [ { "EpilotAuth": [] } ], "paths": { "/v2/organization/current": { "get": { "operationId": "getCurrentOrganization", "x-epilot-permissions": [ { "access": "org" } ], "summary": "getCurrentOrganization", "description": "Retrieves the organization associated with the authenticated user's current session.\n\nThis endpoint is useful for fetching organization details without knowing the organization ID,\nas it automatically resolves the organization from the authentication token.\n", "tags": [ "Organization" ], "responses": { "200": { "description": "The organization associated with the current authenticated user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": { "id": "739224", "name": "Epilot", "email": "contact@epilot.cloud", "phone": "+49123456789", "website": "https://epilot.cloud", "address": { "country": "Germany", "city": "Cologne", "postal_code": "50667", "street": "Im Mediapark", "street_number": "8a" }, "organization_use": "Production", "created_date": "2021-01-15T10:30:00Z", "logo_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png", "signature": "

Best regards,
The epilot Team

" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - User does not have permission to access organization data" } } } }, "/v2/organization/{org_id}": { "get": { "operationId": "getOrganization", "x-epilot-permissions": [ { "access": "org" } ], "summary": "getOrganization", "description": "Retrieves detailed information about a specific organization by its unique identifier.\n\nReturns the organization's profile information including name, contact details,\naddress, branding assets, and configuration.\n", "tags": [ "Organization" ], "parameters": [ { "in": "path", "name": "org_id", "schema": { "$ref": "#/components/schemas/OrganizationId" }, "required": true, "description": "The unique identifier of the organization to retrieve" } ], "responses": { "200": { "description": "Organization details retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": { "id": "739224", "name": "Epilot", "email": "contact@epilot.cloud", "phone": "+49123456789", "website": "https://epilot.cloud", "address": { "country": "Germany", "city": "Cologne", "postal_code": "50667", "street": "Im Mediapark", "street_number": "8a" }, "organization_use": "Production", "created_date": "2021-01-15T10:30:00Z", "logo_url": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png", "signature": "

Best regards,
The epilot Team

" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - User does not have permission to access this organization" }, "404": { "description": "Not Found - Organization with the specified ID does not exist" } } }, "patch": { "operationId": "updateOrganization", "x-epilot-permissions": [ { "action": "organization:edit" } ], "summary": "updateOrganization", "description": "Updates an organization's profile information.\n\nThis endpoint supports partial updates - only the fields provided in the request body\nwill be modified. Fields not included in the request will retain their current values.\n\nCommon use cases:\n- Updating contact information (email, phone, website)\n- Changing the organization name\n- Updating the postal address\n- Setting or updating branding assets (logo_url, logo_thumbnail_url)\n- Configuring the default email signature\n", "tags": [ "Organization" ], "parameters": [ { "in": "path", "name": "org_id", "schema": { "$ref": "#/components/schemas/OrganizationId" }, "required": true, "description": "The unique identifier of the organization to update" } ], "requestBody": { "description": "Organization fields to update. Only provided fields will be modified.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" }, "example": { "name": "Epilot GmbH", "email": "info@epilot.cloud", "phone": "+49221123456", "website": "https://www.epilot.cloud", "address": { "country": "Germany", "city": "Cologne", "postal_code": "50667", "street": "Im Mediapark", "street_number": "8a" }, "logo_url": "https://example.com/new-logo.png", "signature": "

Kind regards,
The epilot Team

" } } } }, "responses": { "200": { "description": "Organization updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } } }, "400": { "description": "Bad Request - Invalid request body or field values" }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - User does not have permission to update this organization" }, "404": { "description": "Not Found - Organization with the specified ID does not exist" } } } }, "/v2/organization/{org_id}/settings": { "get": { "operationId": "getSettings", "x-epilot-permissions": [ { "access": "org" } ], "summary": "getSettings", "description": "Retrieves all configuration settings for an organization.\n\nReturns a key-value map of all settings configured for the organization.\nSettings control various platform features and behaviors including:\n- Feature flags (e.g., double_opt_in, email_tracking)\n- Integration configurations\n- UI preferences\n- Workflow settings\n", "tags": [ "Organization Settings" ], "parameters": [ { "in": "path", "name": "org_id", "schema": { "$ref": "#/components/schemas/OrganizationId" }, "required": true, "description": "The unique identifier of the organization" } ], "responses": { "200": { "description": "Organization settings retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" }, "example": { "double_opt_in": { "enabled": true }, "email_tracking": { "enabled": true, "track_opens": true, "track_clicks": false }, "default_language": "de", "workflow_notifications": { "enabled": true, "channels": [ "email", "in_app" ] } } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - User does not have permission to access organization settings" }, "404": { "description": "Not Found - Organization with the specified ID does not exist" } } } }, "/v2/organization/{org_id}/settings/{key}": { "put": { "operationId": "putSettingsValue", "x-epilot-agent": { "expose": false }, "x-epilot-permissions": [ { "action": "organization:settings" } ], "summary": "putSettingsValue", "description": "Creates or updates a specific organization setting identified by its key.\n\nThe setting value can be any valid JSON type:\n- String (e.g., \"en\", \"production\")\n- Number (e.g., 100, 3.14)\n- Boolean (e.g., true, false)\n- Object (e.g., {\"enabled\": true, \"threshold\": 50})\n- Array (e.g., [\"email\", \"sms\", \"push\"])\n\nIf the setting key does not exist, it will be created. If it exists, its value\nwill be replaced with the new value.\n", "tags": [ "Organization Settings" ], "parameters": [ { "in": "path", "name": "org_id", "schema": { "$ref": "#/components/schemas/OrganizationId" }, "required": true, "description": "The unique identifier of the organization" }, { "in": "path", "name": "key", "schema": { "type": "string" }, "required": true, "description": "The setting key to create or update.\nCommon keys include: double_opt_in, email_tracking, default_language, workflow_notifications\n", "example": "double_opt_in" } ], "requestBody": { "description": "The value to set for the specified setting key", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsValue" }, "examples": { "boolean_setting": { "summary": "Boolean setting", "value": { "enabled": true } }, "string_setting": { "summary": "String setting", "value": "de" }, "object_setting": { "summary": "Object setting", "value": { "enabled": true, "track_opens": true, "track_clicks": false } } } } } }, "responses": { "200": { "description": "Setting updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsValue" }, "example": { "enabled": true } } } }, "400": { "description": "Bad Request - Invalid setting value" }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - User does not have permission to modify organization settings" }, "404": { "description": "Not Found - Organization with the specified ID does not exist" } } }, "delete": { "operationId": "deleteSettingsValue", "x-epilot-agent": { "expose": false }, "x-epilot-permissions": [ { "action": "organization:settings" } ], "summary": "deleteSettingsValue", "description": "Removes a specific organization setting identified by its key.\n\nAfter deletion, the setting will no longer appear in the organization's settings\nand any features relying on this setting will use their default behavior.\n", "tags": [ "Organization Settings" ], "parameters": [ { "in": "path", "name": "org_id", "schema": { "$ref": "#/components/schemas/OrganizationId" }, "required": true, "description": "The unique identifier of the organization" }, { "in": "path", "name": "key", "schema": { "type": "string" }, "required": true, "description": "The setting key to delete", "example": "double_opt_in" } ], "responses": { "200": { "description": "Setting deleted successfully" }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - User does not have permission to delete organization settings" }, "404": { "description": "Not Found - Organization or setting key does not exist" } } } }, "/v2/organization/{org_id}/settings/{key}/notifications": { "post": { "operationId": "notifySettingsValueUpdated", "x-epilot-permissions": [ { "action": "organization:settings" } ], "summary": "notifySettingsValueUpdated", "description": "Sends an internal notification that an organization setting was updated.", "tags": [ "Organization Settings" ], "parameters": [ { "in": "path", "name": "org_id", "schema": { "$ref": "#/components/schemas/OrganizationId" }, "required": true, "description": "The unique identifier of the organization" }, { "in": "path", "name": "key", "schema": { "type": "string" }, "required": true, "description": "The setting key that was updated", "example": "360_features" } ], "requestBody": { "description": "Notification payload for the updated setting", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "user_email": { "type": "string", "description": "Email of the staff user who changed the setting" }, "org_name": { "type": "string", "description": "Organization display name" }, "value": { "$ref": "#/components/schemas/SettingsValue" } } } } } }, "responses": { "200": { "description": "Notification processed", "content": { "application/json": { "schema": { "type": "object", "properties": { "delivered": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - User does not have permission to notify for organization settings" } } } }, "/v2/organization/feature-settings": { "get": { "operationId": "getOrganizationFeatureSettings", "x-epilot-permissions": [ { "access": "org" } ], "summary": "getOrganizationFeatureSettings", "description": "Get organization feature settings.\n\nReturns feature flag metadata for the organization UI.\n\nThis data is static (identical for all organizations) and changes infrequently.\nClients should cache responses using the Cache-Control header.\n", "tags": [ "Feature Settings" ], "responses": { "200": { "description": "Feature settings", "headers": { "cache-control": { "schema": { "type": "string", "example": "public, max-age=3600" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureSettings" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" } } } }, "/v2/feature-settings": { "get": { "operationId": "getFeatureSettings", "x-epilot-permissions": [ { "access": "org" } ], "deprecated": true, "summary": "getFeatureSettings", "description": "Get platform configuration metadata.\n\nDeprecated: use /v2/organization/feature-settings instead.\n", "tags": [ "Feature Settings" ], "responses": { "200": { "description": "Platform configuration metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureSettings" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" } } } }, "/v2/organization/announcements/active": { "get": { "operationId": "getActiveAnnouncement", "x-epilot-permissions": [ { "access": "org" } ], "summary": "getActiveAnnouncement", "description": "Returns the announcement (e.g. a subprocessor change notice) to show as a portal banner for the\ncaller's organization.\n\nOnly the newest published announcement whose acknowledgement window is still open is returned, and\nonly if the organization is eligible (created before the announcement was published) and has not\nacknowledged it yet. Otherwise `announcement` is `null`.\n\n`can_acknowledge` tells whether the caller may acknowledge (requires `organization:edit`).\n", "tags": [ "Announcements" ], "responses": { "200": { "description": "Active announcement for the organization, or null", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveAnnouncementResponse" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" } } } }, "/v2/organization/announcements/{announcement_id}/acknowledge": { "post": { "operationId": "acknowledgeAnnouncement", "x-epilot-permissions": [ { "action": "organization:edit" } ], "summary": "acknowledgeAnnouncement", "description": "Acknowledges an announcement on behalf of the caller's organization. Only org admins\n(`organization:edit`) may acknowledge.\n\nOne acknowledgement per organization: the first acknowledgement wins. Acknowledging an already\nacknowledged announcement returns the existing record.\n", "tags": [ "Announcements" ], "parameters": [ { "$ref": "#/components/parameters/AnnouncementIdPathParam" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "portal": { "type": "string", "description": "Portal the acknowledgement was given in", "example": "360" } } } } } }, "responses": { "200": { "description": "Acknowledgement record of the organization (new or existing)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementOrganizationStatus" } } } }, "401": { "description": "Unauthorized - Invalid or missing authentication token" }, "403": { "description": "Forbidden - Caller is missing the organization:edit permission" }, "404": { "description": "Announcement not found or organization not eligible" }, "409": { "description": "Announcement window closed, announcement superseded or archived" } } } } }, "components": { "securitySchemes": { "EpilotAuth": { "type": "http", "scheme": "bearer", "description": "Authorization header with epilot OAuth2 bearer token", "bearerFormat": "JWT" } }, "parameters": { "AnnouncementIdPathParam": { "in": "path", "name": "announcement_id", "required": true, "schema": { "type": "string" }, "description": "Announcement id" } }, "schemas": { "OrganizationId": { "type": "string", "description": "Unique identifier for an organization (tenant) in the epilot platform", "example": "739224" }, "Organization": { "type": "object", "description": "Represents an epilot organization (tenant).\n\nAn organization contains all the configuration, branding, and contact information\nfor a tenant account on the epilot platform.\n", "properties": { "id": { "$ref": "#/components/schemas/OrganizationId" }, "name": { "type": "string", "description": "Organization name", "example": "Epilot", "nullable": true }, "email": { "type": "string", "description": "Organization contact email", "example": "someone@epilot.cloud", "nullable": true }, "phone": { "description": "Organization contact phone", "type": "string", "example": "+49123123123", "nullable": true }, "website": { "description": "Organization website", "type": "string", "example": "https://epilot.cloud", "nullable": true }, "address": { "description": "Organization postal address", "type": "object", "additionalProperties": true, "properties": { "country": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "street_number": { "type": "string", "nullable": true } } }, "organization_use": { "type": "string", "description": "Indicates whether this is a production, sandbox or preview organization.\nSandbox organizations are linked to a parent production organization for testing purposes.\nPreview organizations are temporary copies of a production organization.\n", "enum": [ "Production", "Sandbox", "Preview" ], "nullable": true }, "parent_production_org_id": { "type": "string", "description": "The ID of the parent production organization.\nOnly set for sandbox organizations to link them to their production counterpart.\n", "nullable": true }, "created_date": { "type": "string", "format": "date-time", "description": "Organization created date" }, "logo_url": { "description": "Organization logo URL", "type": "string", "example": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png", "nullable": true }, "logo_thumbnail_url": { "description": "Organization logo thumbnail URL", "type": "string", "example": "https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png", "nullable": true }, "signature": { "type": "string", "description": "Default email signature of organization", "example": "

Thanks

", "nullable": true }, "is_unlicensed_org": { "type": "boolean", "example": false, "nullable": true, "deprecated": true }, "style": { "type": "object", "description": "Organization style setting (e.g. font setting)", "additionalProperties": true, "nullable": true, "deprecated": true }, "type": { "type": "string", "deprecated": true, "enum": [ "Vendor", "Partner" ], "nullable": true }, "symbol": { "deprecated": true, "type": "string", "example": "EPI", "nullable": true }, "pricing_tier": { "deprecated": true, "description": "Deprecated - Please use pricing tier api", "type": "string", "example": "professional", "nullable": true }, "free_user_limit": { "deprecated": true, "type": "number", "example": 50, "nullable": true }, "tags": { "type": "array", "description": "Labels/tags associated with the organization for categorization and filtering.\nUsed internally to classify organizations (e.g., \"enterprise\", \"beta-tester\", \"test org\").\n", "items": { "type": "string", "example": "test org" }, "nullable": true } } }, "Settings": { "type": "object", "description": "A key-value map of all organization settings.\nKeys are setting identifiers and values can be any valid JSON type.\n", "additionalProperties": true, "example": { "double_opt_in": { "enabled": true }, "email_tracking": { "enabled": true, "track_opens": true }, "default_language": "de" } }, "SettingsValue": { "description": "The value of an organization setting.\nCan be any valid JSON type: string, number, boolean, array, or object.\n", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "object", "additionalProperties": true } ], "example": { "enabled": true } }, "FeatureSettings": { "type": "object", "description": "Feature settings metadata served to frontend applications.", "required": [ "version", "feature_flags" ], "properties": { "version": { "type": "string", "description": "Schema version for backwards compatibility", "example": "1.0.0" }, "feature_flags": { "type": "array", "description": "Feature flag metadata for the settings page", "items": { "$ref": "#/components/schemas/FeatureFlagMetadata" } } } }, "FeatureFlagMetadata": { "type": "object", "description": "Metadata for a single feature flag toggle", "required": [ "feature_name", "visibility_rules" ], "properties": { "feature_name": { "type": "string", "description": "Unique identifier matching the organization setting key", "example": "canary" }, "title": { "$ref": "#/components/schemas/I18nString" }, "description": { "$ref": "#/components/schemas/I18nString" }, "badge": { "type": "string", "description": "Badge label shown next to the feature toggle", "enum": [ "alpha", "beta", "new", "advanced", "experiment", "deprecated" ] }, "confetti": { "type": "boolean", "description": "Whether to show confetti animation when enabled" }, "one_way": { "type": "boolean", "description": "Whether the toggle can only be turned on (not off)" }, "reverse_checked": { "type": "boolean", "description": "Whether the toggle value is inverted (checked = disabled)" }, "is_visible_for_partner": { "type": "boolean", "description": "Whether this feature is visible for partner organizations" }, "visibility_rules": { "type": "array", "description": "Rules that must ALL pass for this feature to be visible (implicit AND)", "items": { "$ref": "#/components/schemas/VisibilityRule" } } } }, "I18nString": { "type": "object", "description": "Internationalized string with a translation key and optional default value", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "Translation key for i18n lookup", "example": "canary_setting.title" }, "default_value": { "type": "string", "description": "Fallback value when translation is not available", "example": "Canary Updates" } } }, "VisibilityRule": { "type": "object", "description": "A rule that determines feature visibility. Rules are combined with AND logic\nat the top level. Supports boolean combinators (and, or, not) for complex logic.\n", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The rule type discriminator", "enum": [ "always", "never", "advanced_mode", "pricing_tier", "pricing_tier_class", "production_org", "feature_flag", "permission", "setting_enabled", "flag_enabled", "not", "and", "or" ] }, "setting_key": { "type": "string", "description": "Setting key for pricing_tier and setting_enabled rules" }, "flag_name": { "type": "string", "description": "Flag name for feature_flag and flag_enabled rules" }, "pricing_tier_classes": { "type": "array", "description": "Pricing tier class names matched (word-boundary, case-insensitive) for pricing_tier_class rules", "items": { "type": "string" }, "example": [ "enterprise", "professional" ] }, "action": { "type": "string", "description": "Permission action for permission rules" }, "resource": { "type": "string", "description": "Optional resource for permission rules" }, "rule": { "$ref": "#/components/schemas/VisibilityRule" }, "rules": { "type": "array", "description": "Child rules for and/or combinators", "items": { "$ref": "#/components/schemas/VisibilityRule" } } } }, "AnnouncementType": { "type": "string", "enum": [ "subprocessor_change" ] }, "AnnouncementMessage": { "type": "object", "required": [ "de" ], "properties": { "de": { "type": "string", "minLength": 1, "example": "Wir haben unsere Liste der Subdienstleister aktualisiert (gültig ab 01.11.2026). Bitte prüfe die Änderungen." }, "en": { "type": "string", "example": "We have updated our list of subprocessors (effective 01.11.2026). Please review the changes." } } }, "Announcement": { "type": "object", "required": [ "id", "type", "message", "link_url", "list_version", "effective_date", "window_days", "status", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/AnnouncementType" }, "message": { "$ref": "#/components/schemas/AnnouncementMessage" }, "link_url": { "type": "string" }, "list_version": { "type": "string" }, "effective_date": { "type": "string", "format": "date" }, "window_days": { "type": "integer" }, "status": { "type": "string", "enum": [ "draft", "published", "archived" ] }, "created_at": { "type": "string", "format": "date-time" }, "created_by": { "type": "string", "description": "Internal caller that created the announcement (not returned to customers)" }, "updated_at": { "type": "string", "format": "date-time" }, "published_at": { "type": "string", "format": "date-time" }, "published_by": { "type": "string", "description": "Internal caller that published the announcement (not returned to customers)" }, "expires_at": { "type": "string", "format": "date-time", "description": "published_at + window_days" }, "archived_at": { "type": "string", "format": "date-time" }, "archived_by": { "type": "string" }, "materialized_at": { "type": "string", "format": "date-time", "description": "When the daily job wrote expired/superseded records after the window closed" } } }, "AnnouncementOrganizationStatusValue": { "type": "string", "enum": [ "acknowledged", "pending", "expired", "superseded" ] }, "AnnouncementOrganizationStatus": { "type": "object", "required": [ "announcement_id", "org_id", "status", "list_version" ], "properties": { "announcement_id": { "type": "string" }, "org_id": { "type": "string" }, "org_name": { "type": "string" }, "status": { "$ref": "#/components/schemas/AnnouncementOrganizationStatusValue" }, "acknowledged_by": { "type": "object", "required": [ "user_id" ], "properties": { "user_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "acknowledged_at": { "type": "string", "format": "date-time" }, "portal": { "type": "string", "example": "360" }, "list_version": { "type": "string" }, "recorded_at": { "type": "string", "format": "date-time", "description": "When the record was written (acknowledgement or materialization by the daily job)" } } }, "ActiveAnnouncementResponse": { "type": "object", "required": [ "announcement", "can_acknowledge" ], "properties": { "announcement": { "allOf": [ { "$ref": "#/components/schemas/Announcement" } ], "nullable": true }, "can_acknowledge": { "type": "boolean", "description": "Whether the caller may acknowledge (organization:edit)" } } } } }, "servers": [ { "url": "https://organization-v2.sls.epilot.io" } ] }