Sample - OpenAI API
POST/organization/projects/{project_id}

Update an organization project

Updates the configurable properties of an organization project. Supply name, external_key_id, or the deprecated geography field to change the corresponding project settings; omitted fields are not changed.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 3 body fields
project_idstringrequired
The unique identifier of the project to update.

The project properties to update.

namestringoptional
The updated name of the project, this name appears in reports.
external_key_idstringoptional
External key ID to associate with the project.
geographystringdeprecatedoptional
Geography for the project. Deprecated: use `residency` when creating a project to configure data residency. This field is retained for backward compatibility.

2 status codes
200Returns the updated project, including its identifier, name, status, timestamps, external key association, and residency configuration.
idstringrequired
The identifier, which can be referenced in API endpoints
objectstringrequired
The object type, which is always `organization.project`
Allowed:organization.project
namestringoptional
The name of the project. This appears in reporting.
created_atintegerrequired
The Unix timestamp (in seconds) of when the project was created.
archived_atintegeroptional
The Unix timestamp (in seconds) of when the project was archived or `null`.
statusstringoptional
`active` or `archived`
external_key_idstringoptional
The external key associated with the project.
residencystringoptional
The residency configuration for the project.
Allowed:GLOBALUS_STORAGE_PROCESSINGEU_STORAGE_PROCESSINGJP_STORAGEKR_STORAGECA_STORAGESG_STORAGEIN_STORAGEAU_STORAGEGB_STORAGEAE_STORAGEAE_STORAGE_PROCESSING
400Returned when the update cannot be applied to the default project.
errorobjectrequired

Error handling

A 400 is returned when the update cannot be applied to the default project. geography is deprecated; use the project's residency configuration instead, and provide name or external_key_id as a string or null value when updating those fields.