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(DataRetentionUpdateParams**kwargs) -> OrganizationDataRetention

POST/organization/data_retention

Updates organization data retention controls.

ParametersExpand Collapse

retention_type: Literal["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: …

Represents the organization’s data retention control setting.

object: Literal["organization.data_retention"]

The object type, which is always organization.data_retention.

type: Literal["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

Python

HTTP

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
organization_data_retention = client.admin.organization.data_retention.update(
    retention_type="zero_data_retention",
)
print(organization_data_retention.object)

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

Returns Examples

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