OpenAI API (unofficial showcase)
POST/organization/projects/{project_id}

Update an organization project

Updates a project in the organization. Supply any of name, external_key_id, or geography to change the corresponding project value; omitted fields are not specified for update. The geography field is retained for backward compatibility, while data residency is configured with residency when creating a project.

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

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

Project update fields; provide the values you want to change.

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.

5 status codes
200Returns the updated project object, including its identifier, name, status, external key ID, 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_STORAGEJP_STORAGE_PROCESSINGKR_STORAGECA_STORAGESG_STORAGEIN_STORAGEIN_STORAGE_PROCESSINGAU_STORAGEAU_STORAGE_PROCESSING
400Returned when an error occurs while updating the default project.
errorobjectrequired
403Returned when the authenticated user does not have permission to modify the project.
errorobjectrequired
Details about the permission error.
404Returned when a requested project, user, service account, or API key is not found.
errorobjectrequired
429Returned when too many management requests are made; reduce the request rate and try again later.
errorobjectrequired

Error handling

A 400 is returned when updating the default project fails, and a 403 is returned when the authenticated user lacks permission. A 404 is returned when a requested project, user, service account, or API key is not found; a 429 is returned when management requests are sent too frequently. The project_id path parameter identifies the project to update.