API Reference

Admin

Organization

Data Retention

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update organization data retention

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

POST/organization/data_retention

Updates organization data retention controls.

ParametersExpand Collapse

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

ReturnsExpand Collapse

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.

One of the following:

:zero_data_retention

:modified_abuse_monitoring

:enhanced_zero_data_retention

:enhanced_modified_abuse_monitoring

Update organization data retention

Ruby

HTTP

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

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)

{
    "object": "organization.data_retention",
    "type": "modified_abuse_monitoring"
}

Returns Examples

{
    "object": "organization.data_retention",
    "type": "modified_abuse_monitoring"
}