Actualizar una organización

PUT /api/v1/organizations/{id}

Autorización del portador

Actualiza campos de la organización, como el nombre o la descripción.

Parámetros de path

ID string Requerido

identificador de la organización

application/json

Cuerpo Requerido

Campos a actualizar

Descripción string
Nombre string

El nombre se recorta antes de la validación. Debe tener entre 1y64 caracteres y puede contener letras/números Unicode, espacios y los caracteres - _ . ( ) , & @ + '.

La longitud mínima es de 1, la longitud máxima es de 64.

Respuestas

406

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.
  
  Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  Campos arreglo[objeto]
  
  Campos con errores de validación.
  
  Ocultar campos atributos Mostrar los atributos de los campos Objeto
  
  Un campo y su fallo de validación.
  
  Descripción string Requerido
  
  Fallo en la validación legible para humanos.
  
  Campo string Requerido
  
  Nombre o ruta del campo de solicitud no válido.
- detalle string Requerido
  
  Detalles de errores legibles para humanos.
- Error entero Requerido
  
  HTTP status code.
- errorCode string Requerido
  
  Código de error legible por máquina.
- Parámetros array[string]
  
  Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.
- motivo string Requerido
  
  Frase que indica el motivo del estado HTTP.
200

aplicación/vnd.agent-engine-2026-09-20-preview+json

aplicación/vnd.agent-engine-2026-09-20-preview+json application/json

OK
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- administradores arreglo[objeto]
  
  La lista de administradores muestra los ORG_ADMINS de la organización. Solo se muestra en la lista de administradores de la plataforma; se omite en los puntos de acceso de la organización a los miembros.
  
  Ocultar atributos de administrador Mostrar atributos de administrador Objeto
  
  correo electrónico string
  
  Nombre string
- atlas Objeto
  
  Ocultar atributos del atlas Mostrar atributos del atlas Objeto
  
  entorno string Requerido
  
  ID string Requerido
- created_at string
- Descripción string
- ID string
- Nombre string
- Origen string
  
  Los valores son atlas o agent_engine.
- updated_at string
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- administradores arreglo[objeto]
  
  La lista de administradores muestra los ORG_ADMINS de la organización. Solo se muestra en la lista de administradores de la plataforma; se omite en los puntos de acceso de la organización a los miembros.
  
  Ocultar atributos de administrador Mostrar atributos de administrador Objeto
  
  correo electrónico string
  
  Nombre string
- atlas Objeto
  
  Ocultar atributos del atlas Mostrar atributos del atlas Objeto
  
  entorno string Requerido
  
  ID string Requerido
- created_at string
- Descripción string
- ID string
- Nombre string
- Origen string
  
  Los valores son atlas o agent_engine.
- updated_at string
400

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Solicitud incorrecta
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
404

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

No encontrado
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
500

application/json

application/json aplicación/vnd.agent-engine-2026-09-20-preview+json

Error interno del servidor
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- Código string
- Error string
- éxito booleano

PUT /api/v1/organizations/{id}

curl \
 --request PUT 'https://agentengine.mongodb.com/api/v1/organizations/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "description": "string",
  "name": "string"
}'

Solicitar ejemplos

{
  "description": "string",
  "name": "string"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (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"
}

Ejemplos de respuesta (200)

{
  "admins": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "atlas": {
    "environment": "string",
    "id": "string"
  },
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "source": "atlas",
  "updated_at": "string"
}

Ejemplos de respuesta (200)

{
  "admins": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "atlas": {
    "environment": "string",
    "id": "string"
  },
  "created_at": "string",
  "description": "string",
  "id": "string",
  "name": "string",
  "source": "atlas",
  "updated_at": "string"
}

Ejemplos de respuesta (400)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (400)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (404)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (404)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (500)

{
  "code": "string",
  "error": "string",
  "success": true
}

Ejemplos de respuesta (500)

{
  "code": "string",
  "error": "string",
  "success": true
}