OpenAI API (unofficial showcase)
POST/organization/data_retention

Update organization data retention controls

Updates the organization's data retention controls. Set retention_type to one of the supported retention modes; the requested setting or transition must be valid for the organization.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

The desired organization data retention setting.

retention_typestringrequired
The desired organization data retention type.
Allowed:zero_data_retentionmodified_abuse_monitoringenhanced_zero_data_retentionenhanced_modified_abuse_monitoring

4 status codes
200Returns the updated organization data retention control object, including its configured type.
objectstringrequired
The object type, which is always `organization.data_retention`.
Allowed:organization.data_retention
typestringrequired
The configured organization data retention type.
Allowed:zero_data_retentionmodified_abuse_monitoringenhanced_zero_data_retentionenhanced_modified_abuse_monitoring
400Returned when the requested data retention setting or transition is invalid.
errorobjectrequired
403Returned when the caller does not have permission to update organization data retention controls.
errorobjectrequired
Details about the permission error.
404Returned when the organization is not found.
errorobjectrequired

Error handling

A 400 is returned when the requested retention setting or transition is invalid. A 403 is returned when the authenticated user lacks permission to update organization data retention controls. A 404 is returned when the organization is not found. retention_type must be one of zero_data_retention, modified_abuse_monitoring, enhanced_zero_data_retention, or enhanced_modified_abuse_monitoring.