Skip to main content

updateComponent

form schema

Update a component's mutable fields (name, description, attributes).

The component ID and underlying bundle cannot be changed after creation. Attributes are validated against the organization's custom-attribute schema for the component scope.

mutation {
  updateComponent(
    organizationId: "my-org"
    id: "my-project-database"
    input: { name: "Primary Database", description: "User data" }
  ) {
    result { id name description }
    successful
  }
}
updateComponent(
  organizationId: ID!
  id: ID!
  input: UpdateComponentInput!
): ComponentPayload

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

updateComponent.organizationId ● ID! non-null scalar {#organization-id}​

Your organization's unique identifier.

updateComponent.id ● ID! non-null scalar {#id}​

The component ID to update (e.g., myproj-database).

updateComponent.input ● UpdateComponentInput! non-null input {#input}​

Update an existing component's name, description, and attributes. The component ID and underlying bundle cannot be changed.

Type​

ComponentPayload object​