Modifies a project in the organization.

POST /organization/projects/{project_id}
Api key auth

Path parameters

  • project_id string Required

    The ID of the project.

application/json

Body Required

The project update request payload.

  • name string Required

    The updated name of the project, this name appears in reports.

Responses

  • 200 application/json

    Project updated successfully.

    Hide response attributes Show response attributes object
    • id string Required

      The identifier, which can be referenced in API endpoints

    • object string Required

      The object type, which is always organization.project

      Value is organization.project.

    • name string Required

      The name of the project. This appears in reporting.

    • created_at integer Required

      The Unix timestamp (in seconds) of when the project was created.

    • archived_at integer | null

      The Unix timestamp (in seconds) of when the project was archived or null.

    • status string Required

      active or archived

      Values are active or archived.
  • 400 application/json

    Error response when updating the default project.

    Hide response attribute Show response attribute object
    • error object Required
      Hide error attributes Show error attributes object
      • code string | null Required
      • message string Required
      • param string | null Required
      • type string Required
POST /organization/projects/{project_id} 
curl \
 --request POST 'https://api.openai.com/v1/organization/projects/{project_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string"}'
Request examples 
{
  "name": "string"
}
Response examples (200) 
{
  "id": "string",
  "object": "organization.project",
  "name": "string",
  "created_at": 42,
  "archived_at": 42,
  "status": "active"
}
Response examples (400) 
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string",
    "type": "string"
  }
}