PUT /api/v1/projects/{id}
Bearer auth

Update an existing project's name, description, or settings.

Path parameters

  • id string Required

    Project ID

application/json

Body Required

Fields to update

  • allow_member_invites boolean
  • description string
  • name string

    Name is trimmed before validation. It must be 1-64 characters and may contain Unicode letters/numbers, spaces, and the characters - _ . ( ) , & @ + '.

    Minimum length is 1, maximum length is 64.

  • sharing_policy object
    Hide sharing_policy attributes Show sharing_policy attributes object
    • allowed_sources array[string]
    • share_modes array[string]
    • shareable boolean

Responses

  • 406

    Unsupported or malformed API version, an operation unavailable in the selected published contract, or an unacceptable representation (including unsupported media-type parameters or excluded SSE). Existing authentication, authorization, and rate-limit failures take precedence.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.
  • 200

    OK

    Hide response attributes Show response attributes object
    • allow_member_invites boolean
    • atlas object
      Hide atlas attributes Show atlas attributes object
      • environment string Required
      • id string Required
      • organization_id string Required
    • can_manage_deployments boolean
    • created_at string
    • description string
    • id string
    • name string
    • org_id string
    • sharing_policy object
      Hide sharing_policy attributes Show sharing_policy attributes object
      • allowed_sources array[string]
      • share_modes array[string]
      • shareable boolean
    • source string

      Values are atlas or agent_engine.

    • updated_at string
    • workspace_count integer

      WorkspaceCount is the number of non-deleted workspaces in the project. Included on list responses and omitted on single-project GET.

    Hide response attributes Show response attributes object
    • allow_member_invites boolean
    • atlas object
      Hide atlas attributes Show atlas attributes object
      • environment string Required
      • id string Required
      • organization_id string Required
    • can_manage_deployments boolean
    • created_at string
    • description string
    • id string
    • name string
    • org_id string
    • sharing_policy object
      Hide sharing_policy attributes Show sharing_policy attributes object
      • allowed_sources array[string]
      • share_modes array[string]
      • shareable boolean
    • source string

      Values are atlas or agent_engine.

    • updated_at string
    • workspace_count integer

      WorkspaceCount is the number of non-deleted workspaces in the project. Included on list responses and omitted on single-project GET.
  • 400

    Bad Request

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 404

    Not Found

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 409

    Conflict

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 500

    Internal Server Error

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
PUT /api/v1/projects/{id} 
curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/projects/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "allow_member_invites": true,
  "description": "string",
  "name": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": true
  }
}'
Request examples 
{
  "allow_member_invites": true,
  "description": "string",
  "name": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": true
  }
}
Response examples (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Response examples (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Response examples (200) 
{
  "allow_member_invites": true,
  "atlas": {
    "environment": "string",
    "id": "string",
    "organization_id": "string"
  },
  "can_manage_deployments": true,
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": true
  },
  "source": "atlas",
  "updated_at": "string",
  "workspace_count": 42
}
Response examples (200) 
{
  "allow_member_invites": true,
  "atlas": {
    "environment": "string",
    "id": "string",
    "organization_id": "string"
  },
  "can_manage_deployments": true,
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "sharing_policy": {
    "allowed_sources": [
      "string"
    ],
    "share_modes": [
      "string"
    ],
    "shareable": true
  },
  "source": "atlas",
  "updated_at": "string",
  "workspace_count": 42
}
Response examples (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (409) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}