Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation
Theme

Update organization data retention

admin.organization.data_retention.update(**kwargs) -> OrganizationDataRetention { object, type }
POST
/organization/data_retention

Updates organization data retention controls.

Parameters
retention_type: :zero_data_retention | :modified_abuse_monitoring | :enhanced_zero_data_retention | :enhanced_modified_abuse_monitoring

The desired organization data retention type.

One of the following:
:zero_data_retention
:modified_abuse_monitoring
:enhanced_zero_data_retention
:enhanced_modified_abuse_monitoring
Returns
class OrganizationDataRetention { object, type }

Represents the organization’s data retention control setting.

object: :"organization.data_retention"

The object type, which is always organization.data_retention.

type: :zero_data_retention | :modified_abuse_monitoring | :enhanced_zero_data_retention | :enhanced_modified_abuse_monitoring

The configured organization data retention type.

Update organization data retention

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

organization_data_retention = openai.admin.organization.data_retention.update(retention_type: :zero_data_retention)

puts(organization_data_retention)
Response example
{
    "object": "organization.data_retention",
    "type": "modified_abuse_monitoring"
}
Returns Examples
Response example
{
    "object": "organization.data_retention",
    "type": "modified_abuse_monitoring"
}