# Update object by UUID

Updates an existing object identified by its UUID with new details. Optional parameters determine if views, properties, and relations should be included in the response. Validation rules: label (required, must be a string, maximum 32 characters), plural (required, must be a string, maximum 32 characters), name (required, must be a string, must be lowercase, must be unique, must match name pattern (lowercase letters, numbers, underscores), cannot be changed after creation), description (optional, maximum 255 characters), groups (required, must be an array of string, no duplicate values allowed), showInMenu (required, must be a boolean).

Endpoint: PUT /api/v2/objects/{uuid}
Version: 2.0
Security: Bearer Authentication

## Path parameters:

  - `uuid` (string, required)

## Query parameters:

  - `views` (string)

  - `properties` (string)

  - `relations` (string)

## Request fields (application/json):

  - `uuid` (string, required)
    Unique identifier for the entity

  - `name` (string)
    Unique identifier name for the object

  - `label` (string)
    Display label for the object

  - `createdAt` (integer)
    Unix timestamp when the entity was created

  - `createdBy` (object)
    Identifier of the user who created the entity

  - `createdBy.name` (string, required)

  - `createdBy.label` (string)

  - `createdBy.createdAt` (integer)

  - `createdBy.updatedAt` (integer)

  - `createdBy.deletedAt` (integer)

  - `createdBy.createdByUuid` (string)

  - `createdBy.updatedByUuid` (string)

  - `createdBy.deletedByUuid` (string)

  - `createdBy.index` (integer)

  - `createdBy.deleted` (boolean)

  - `createdBy.complete` (boolean)

  - `createdBy.uuid` (string, required)

  - `createdBy.properties` (array)

  - `createdBy.properties.icon` (string)

  - `createdBy.properties.name` (string)

  - `createdBy.properties.value` (any)

  - `createdBy.properties.type` (string)

  - `createdBy.properties.label` (string)

  - `createdBy.objects` (object)

  - `createdBy.user` (object)

  - `createdBy.user.uuid` (string)

  - `createdBy.user.email` (string)

  - `createdBy.user.firstname` (string)

  - `createdBy.user.lastname` (string)

  - `createdBy.user.initials` (string)

  - `createdBy.user.scopes` (array)

  - `createdBy.user.filters` (object)

  - `createdBy.user.role` (string)

  - `createdBy.user.record` (object)

  - `updatedAt` (integer)
    Unix timestamp when the entity was last updated

  - `updatedBy` (object)
    Identifier of the user who last updated the entity

  - `updatedBy.name` (string, required)

  - `updatedBy.label` (string)

  - `updatedBy.createdAt` (integer)

  - `updatedBy.updatedAt` (integer)

  - `updatedBy.deletedAt` (integer)

  - `updatedBy.createdByUuid` (string)

  - `updatedBy.updatedByUuid` (string)

  - `updatedBy.deletedByUuid` (string)

  - `updatedBy.index` (integer)

  - `updatedBy.deleted` (boolean)

  - `updatedBy.complete` (boolean)

  - `updatedBy.uuid` (string, required)

  - `updatedBy.properties` (array)

  - `updatedBy.properties.icon` (string)

  - `updatedBy.properties.name` (string)

  - `updatedBy.properties.value` (any)

  - `updatedBy.properties.type` (string)

  - `updatedBy.properties.label` (string)

  - `updatedBy.objects` (object)

  - `updatedBy.user` (object)

  - `updatedBy.user.uuid` (string)

  - `updatedBy.user.email` (string)

  - `updatedBy.user.firstname` (string)

  - `updatedBy.user.lastname` (string)

  - `updatedBy.user.initials` (string)

  - `updatedBy.user.scopes` (array)

  - `updatedBy.user.filters` (object)

  - `updatedBy.user.role` (string)

  - `updatedBy.user.record` (object)

  - `deletedAt` (integer)
    Unix timestamp when the entity was deleted (null if not deleted)

  - `deletedBy` (object)
    Identifier of the user who deleted the entity

  - `deletedBy.name` (string, required)

  - `deletedBy.label` (string)

  - `deletedBy.createdAt` (integer)

  - `deletedBy.updatedAt` (integer)

  - `deletedBy.deletedAt` (integer)

  - `deletedBy.createdByUuid` (string)

  - `deletedBy.updatedByUuid` (string)

  - `deletedBy.deletedByUuid` (string)

  - `deletedBy.index` (integer)

  - `deletedBy.deleted` (boolean)

  - `deletedBy.complete` (boolean)

  - `deletedBy.uuid` (string, required)

  - `deletedBy.properties` (array)

  - `deletedBy.properties.icon` (string)

  - `deletedBy.properties.name` (string)

  - `deletedBy.properties.value` (any)

  - `deletedBy.properties.type` (string)

  - `deletedBy.properties.label` (string)

  - `deletedBy.objects` (object)

  - `deletedBy.user` (object)

  - `deletedBy.user.uuid` (string)

  - `deletedBy.user.email` (string)

  - `deletedBy.user.firstname` (string)

  - `deletedBy.user.lastname` (string)

  - `deletedBy.user.initials` (string)

  - `deletedBy.user.scopes` (array)

  - `deletedBy.user.filters` (object)

  - `deletedBy.user.role` (string)

  - `deletedBy.user.record` (object)

  - `index` (integer)
    Index number for ordering objects

  - `plural` (string)
    Plural form of the object's name, used for display purposes

  - `description` (string)
    Detailed description of the object's purpose and usage

  - `groups` (array)
    Collection of group names this object belongs to

  - `icon` (string)
    Icon identifier for visual representation of the object

  - `showInMenu` (boolean)
    Indicates if this object should be displayed in navigation menus

  - `defaultTrait` (string)
    Name of the default trait applied to this object

  - `traits` (array)
    List of trait names associated with this object

  - `views` (array)
    List of view configurations for displaying this object

  - `views.uuid` (string, required)
    Unique identifier for the entity

  - `views.name` (string)

  - `views.label` (string)
    Display label for the entity, can be different from name

  - `views.createdAt` (integer)
    Unix timestamp when the entity was created

  - `views.createdBy` (object)
    Identifier of the user who created the entity

  - `views.createdBy.name` (string, required)

  - `views.createdBy.label` (string)

  - `views.createdBy.createdAt` (integer)

  - `views.createdBy.updatedAt` (integer)

  - `views.createdBy.deletedAt` (integer)

  - `views.createdBy.createdByUuid` (string)

  - `views.createdBy.updatedByUuid` (string)

  - `views.createdBy.deletedByUuid` (string)

  - `views.createdBy.index` (integer)

  - `views.createdBy.deleted` (boolean)

  - `views.createdBy.complete` (boolean)

  - `views.createdBy.uuid` (string, required)

  - `views.createdBy.properties` (array)

  - `views.createdBy.properties.icon` (string)

  - `views.createdBy.properties.name` (string)

  - `views.createdBy.properties.value` (any)

  - `views.createdBy.properties.type` (string)

  - `views.createdBy.properties.label` (string)

  - `views.createdBy.objects` (object)

  - `views.createdBy.user` (object)

  - `views.createdBy.user.uuid` (string)

  - `views.createdBy.user.email` (string)

  - `views.createdBy.user.firstname` (string)

  - `views.createdBy.user.lastname` (string)

  - `views.createdBy.user.initials` (string)

  - `views.createdBy.user.scopes` (array)

  - `views.createdBy.user.filters` (object)

  - `views.createdBy.user.role` (string)

  - `views.createdBy.user.record` (object)

  - `views.updatedAt` (integer)
    Unix timestamp when the entity was last updated

  - `views.updatedBy` (object)
    Identifier of the user who last updated the entity

  - `views.updatedBy.name` (string, required)

  - `views.updatedBy.label` (string)

  - `views.updatedBy.createdAt` (integer)

  - `views.updatedBy.updatedAt` (integer)

  - `views.updatedBy.deletedAt` (integer)

  - `views.updatedBy.createdByUuid` (string)

  - `views.updatedBy.updatedByUuid` (string)

  - `views.updatedBy.deletedByUuid` (string)

  - `views.updatedBy.index` (integer)

  - `views.updatedBy.deleted` (boolean)

  - `views.updatedBy.complete` (boolean)

  - `views.updatedBy.uuid` (string, required)

  - `views.updatedBy.properties` (array)

  - `views.updatedBy.properties.icon` (string)

  - `views.updatedBy.properties.name` (string)

  - `views.updatedBy.properties.value` (any)

  - `views.updatedBy.properties.type` (string)

  - `views.updatedBy.properties.label` (string)

  - `views.updatedBy.objects` (object)

  - `views.updatedBy.user` (object)

  - `views.updatedBy.user.uuid` (string)

  - `views.updatedBy.user.email` (string)

  - `views.updatedBy.user.firstname` (string)

  - `views.updatedBy.user.lastname` (string)

  - `views.updatedBy.user.initials` (string)

  - `views.updatedBy.user.scopes` (array)

  - `views.updatedBy.user.filters` (object)

  - `views.updatedBy.user.role` (string)

  - `views.updatedBy.user.record` (object)

  - `views.deletedAt` (integer)
    Unix timestamp when the entity was deleted (null if not deleted)

  - `views.deletedBy` (object)
    Identifier of the user who deleted the entity

  - `views.deletedBy.name` (string, required)

  - `views.deletedBy.label` (string)

  - `views.deletedBy.createdAt` (integer)

  - `views.deletedBy.updatedAt` (integer)

  - `views.deletedBy.deletedAt` (integer)

  - `views.deletedBy.createdByUuid` (string)

  - `views.deletedBy.updatedByUuid` (string)

  - `views.deletedBy.deletedByUuid` (string)

  - `views.deletedBy.index` (integer)

  - `views.deletedBy.deleted` (boolean)

  - `views.deletedBy.complete` (boolean)

  - `views.deletedBy.uuid` (string, required)

  - `views.deletedBy.properties` (array)

  - `views.deletedBy.properties.icon` (string)

  - `views.deletedBy.properties.name` (string)

  - `views.deletedBy.properties.value` (any)

  - `views.deletedBy.properties.type` (string)

  - `views.deletedBy.properties.label` (string)

  - `views.deletedBy.objects` (object)

  - `views.deletedBy.user` (object)

  - `views.deletedBy.user.uuid` (string)

  - `views.deletedBy.user.email` (string)

  - `views.deletedBy.user.firstname` (string)

  - `views.deletedBy.user.lastname` (string)

  - `views.deletedBy.user.initials` (string)

  - `views.deletedBy.user.scopes` (array)

  - `views.deletedBy.user.filters` (object)

  - `views.deletedBy.user.role` (string)

  - `views.deletedBy.user.record` (object)

  - `views.index` (integer)
    Index number for ordering entities

  - `views.favorite` (boolean)

  - `views.team` (boolean)

  - `views.shared` (boolean)

  - `views.personal` (boolean)

  - `views.trait` (string)

  - `views.filters` (object)
    DTO representing a filter composed of filter groups for querying records. The filter groups are combined using a logical OR operation. The filter items within each group are combined using a logical AND operation.

  - `views.filters.groups` (array)
    A collection of filter groups.

  - `views.filters.groups.items` (object)
    A set of filter items included in the group.

  - `views.filters.groups.items.object` (string)
    The name of the object to which this pagination item belongs.
    Example: "User"

  - `views.filters.groups.items.relation` (string)
    The relationship between objects.
    Example: "hasProperty"

  - `views.filters.groups.items.property` (string)
    The name of the property within the object.
    Example: "email"

  - `views.filters.groups.items.relationIncluded` (boolean)
    Specifies whether the relation is included.
    Example: true

  - `views.filters.groups.items.operator` (string)
    Defines the operator used in the filter. Available operators are defined in the API documentation.
    Example: "EQUALS"

  - `views.filters.groups.items.value` (any)
    Represents the value to filter against.
    Example: 12345

  - `views.filters.groups.items.smartContent` (boolean)
    When true, filter fields contain smart content placeholders resolved at runtime.
    Example: true

  - `views.shows` (array)

  - `views.shows.object` (string)
    The name of the object to which this pagination item belongs.
    Example: "User"

  - `views.shows.relation` (string)
    The relationship between objects.
    Example: "hasProperty"

  - `views.shows.property` (string)
    The name of the property within the object.
    Example: "email"

  - `views.shows.separator` (string)
    Separator string used to visually separate this item.
    Example: "|"

  - `views.shows.sticky` (boolean)
    Flag indicating whether this item is sticky and will stay fixed in the list.

  - `views.shows.width` (integer)
    Width of the item in pixels.
    Example: 100

  - `views.shows.calculationFunction` (string)
    Calculation function used to calculate the value of the item.
    Example: "max"

  - `views.shows.calculationResult` (any)
    Result of the calculation.
    Example: 100

  - `views.sorts` (array)

  - `views.sorts.object` (string)
    The name of the object to which this pagination item belongs.
    Example: "User"

  - `views.sorts.relation` (string)
    The relationship between objects.
    Example: "hasProperty"

  - `views.sorts.property` (string)
    The name of the property within the object.
    Example: "email"

  - `views.sorts.direction` (string)
    The direction for sorting. Can be ASC (ascending) or DESC (descending).
    Enum: "ASC", "DESC"

  - `views.limit` (integer)

  - `views.showIcons` (boolean)

  - `views.rowHeight` (string)

  - `views.query` (string)

  - `views.icon` (string)

  - `views.flowProperty` (string)

  - `views.flowPreview` (string)

  - `views.defaultView` (boolean)

  - `views.isInternallyPublic` (boolean)

  - `properties` (array)
    List of properties defined for this object

  - `properties.uuid` (string, required)
    Unique identifier for the entity

  - `properties.name` (string)
    The name identifier of the property

  - `properties.label` (string)
    Display label for the property

  - `properties.createdAt` (integer)
    Unix timestamp when the entity was created

  - `properties.createdBy` (object)
    Identifier of the user who created the entity

  - `properties.createdBy.name` (string, required)

  - `properties.createdBy.label` (string)

  - `properties.createdBy.createdAt` (integer)

  - `properties.createdBy.updatedAt` (integer)

  - `properties.createdBy.deletedAt` (integer)

  - `properties.createdBy.createdByUuid` (string)

  - `properties.createdBy.updatedByUuid` (string)

  - `properties.createdBy.deletedByUuid` (string)

  - `properties.createdBy.index` (integer)

  - `properties.createdBy.deleted` (boolean)

  - `properties.createdBy.complete` (boolean)

  - `properties.createdBy.uuid` (string, required)

  - `properties.createdBy.properties` (array)

  - `properties.createdBy.properties.icon` (string)

  - `properties.createdBy.properties.name` (string)

  - `properties.createdBy.properties.value` (any)

  - `properties.createdBy.properties.type` (string)

  - `properties.createdBy.properties.label` (string)

  - `properties.createdBy.objects` (object)

  - `properties.createdBy.user` (object)

  - `properties.createdBy.user.uuid` (string)

  - `properties.createdBy.user.email` (string)

  - `properties.createdBy.user.firstname` (string)

  - `properties.createdBy.user.lastname` (string)

  - `properties.createdBy.user.initials` (string)

  - `properties.createdBy.user.scopes` (array)

  - `properties.createdBy.user.filters` (object)

  - `properties.createdBy.user.role` (string)

  - `properties.createdBy.user.record` (object)

  - `properties.updatedAt` (integer)
    Unix timestamp when the entity was last updated

  - `properties.updatedBy` (object)
    Identifier of the user who last updated the entity

  - `properties.updatedBy.name` (string, required)

  - `properties.updatedBy.label` (string)

  - `properties.updatedBy.createdAt` (integer)

  - `properties.updatedBy.updatedAt` (integer)

  - `properties.updatedBy.deletedAt` (integer)

  - `properties.updatedBy.createdByUuid` (string)

  - `properties.updatedBy.updatedByUuid` (string)

  - `properties.updatedBy.deletedByUuid` (string)

  - `properties.updatedBy.index` (integer)

  - `properties.updatedBy.deleted` (boolean)

  - `properties.updatedBy.complete` (boolean)

  - `properties.updatedBy.uuid` (string, required)

  - `properties.updatedBy.properties` (array)

  - `properties.updatedBy.properties.icon` (string)

  - `properties.updatedBy.properties.name` (string)

  - `properties.updatedBy.properties.value` (any)

  - `properties.updatedBy.properties.type` (string)

  - `properties.updatedBy.properties.label` (string)

  - `properties.updatedBy.objects` (object)

  - `properties.updatedBy.user` (object)

  - `properties.updatedBy.user.uuid` (string)

  - `properties.updatedBy.user.email` (string)

  - `properties.updatedBy.user.firstname` (string)

  - `properties.updatedBy.user.lastname` (string)

  - `properties.updatedBy.user.initials` (string)

  - `properties.updatedBy.user.scopes` (array)

  - `properties.updatedBy.user.filters` (object)

  - `properties.updatedBy.user.role` (string)

  - `properties.updatedBy.user.record` (object)

  - `properties.deletedAt` (integer)
    Unix timestamp when the entity was deleted (null if not deleted)

  - `properties.deletedBy` (object)
    Identifier of the user who deleted the entity

  - `properties.deletedBy.name` (string, required)

  - `properties.deletedBy.label` (string)

  - `properties.deletedBy.createdAt` (integer)

  - `properties.deletedBy.updatedAt` (integer)

  - `properties.deletedBy.deletedAt` (integer)

  - `properties.deletedBy.createdByUuid` (string)

  - `properties.deletedBy.updatedByUuid` (string)

  - `properties.deletedBy.deletedByUuid` (string)

  - `properties.deletedBy.index` (integer)

  - `properties.deletedBy.deleted` (boolean)

  - `properties.deletedBy.complete` (boolean)

  - `properties.deletedBy.uuid` (string, required)

  - `properties.deletedBy.properties` (array)

  - `properties.deletedBy.properties.icon` (string)

  - `properties.deletedBy.properties.name` (string)

  - `properties.deletedBy.properties.value` (any)

  - `properties.deletedBy.properties.type` (string)

  - `properties.deletedBy.properties.label` (string)

  - `properties.deletedBy.objects` (object)

  - `properties.deletedBy.user` (object)

  - `properties.deletedBy.user.uuid` (string)

  - `properties.deletedBy.user.email` (string)

  - `properties.deletedBy.user.firstname` (string)

  - `properties.deletedBy.user.lastname` (string)

  - `properties.deletedBy.user.initials` (string)

  - `properties.deletedBy.user.scopes` (array)

  - `properties.deletedBy.user.filters` (object)

  - `properties.deletedBy.user.role` (string)

  - `properties.deletedBy.user.record` (object)

  - `properties.index` (integer)
    Index number for ordering entities

  - `properties.description` (string)
    Detailed description of the property's purpose and usage

  - `properties.type` (string)
    The data type of the property (e.g., 'string', 'number', 'date', etc.)

  - `properties.options` (array)
    List of predefined options for properties that support selection

  - `properties.options.name` (string)

  - `properties.options.label` (string)

  - `properties.options.icon` (string)

  - `properties.options.color` (string)

  - `properties.options.disabled` (boolean)

  - `properties.options.usedIn` (object)

  - `properties.options.usedIn.recordUuids` (array)

  - `properties.options.usedIn.count` (integer)

  - `properties.group` (string)
    Group name for organizing related properties

  - `properties.format` (any)
    Format configuration for the property's display and validation

  - `properties.rules` (array)
    Collection of validation rules applied to the property

  - `properties.immutable` (boolean)
    Indicates if the property value cannot be modified after initial creation

  - `properties.hidden` (boolean)
    Indicates if the property should be hidden from view

  - `properties.nonPublic` (boolean)
    Indicates if the property should be excluded from public APIs

  - `properties.indexed` (boolean)
    Indicates if the property should be indexed for searching

  - `properties.editable` (boolean)
    Indicates if the property value can be modified

  - `properties.formatSettings` (object)
    Additional format-specific settings for the property

  - `properties.usedIn` (object)
    Information about where this property is used in the system

  - `properties.usedIn.recordUuids` (array)

  - `properties.usedIn.count` (integer)

  - `properties.icon` (string)
    Icon identifier for visual representation of the property

  - `properties.webpagePublic` (boolean)
    Indicates if the property can be used in webpages

  - `properties.embeddable` (boolean)
    Indicates if the property can be embedded in other properties

  - `properties.minAndMaxValue` (object)
    The minimum and maximum value of the property

  - `properties.minAndMaxValue.t1` (integer)

  - `properties.minAndMaxValue.t2` (integer)

  - `relations` (array)
    List of relations this object has with other objects

  - `relations.uuid` (string, required)
    Unique identifier for the entity

  - `relations.name` (string)
    Unique identifier name for the relation

  - `relations.label` (string)
    Display label for the relation

  - `relations.createdAt` (integer)
    Unix timestamp when the entity was created

  - `relations.createdBy` (object)
    Identifier of the user who created the entity

  - `relations.createdBy.name` (string, required)

  - `relations.createdBy.label` (string)

  - `relations.createdBy.createdAt` (integer)

  - `relations.createdBy.updatedAt` (integer)

  - `relations.createdBy.deletedAt` (integer)

  - `relations.createdBy.createdByUuid` (string)

  - `relations.createdBy.updatedByUuid` (string)

  - `relations.createdBy.deletedByUuid` (string)

  - `relations.createdBy.index` (integer)

  - `relations.createdBy.deleted` (boolean)

  - `relations.createdBy.complete` (boolean)

  - `relations.createdBy.uuid` (string, required)

  - `relations.createdBy.properties` (array)

  - `relations.createdBy.properties.icon` (string)

  - `relations.createdBy.properties.name` (string)

  - `relations.createdBy.properties.value` (any)

  - `relations.createdBy.properties.type` (string)

  - `relations.createdBy.properties.label` (string)

  - `relations.createdBy.objects` (object)

  - `relations.createdBy.user` (object)

  - `relations.createdBy.user.uuid` (string)

  - `relations.createdBy.user.email` (string)

  - `relations.createdBy.user.firstname` (string)

  - `relations.createdBy.user.lastname` (string)

  - `relations.createdBy.user.initials` (string)

  - `relations.createdBy.user.scopes` (array)

  - `relations.createdBy.user.filters` (object)

  - `relations.createdBy.user.role` (string)

  - `relations.createdBy.user.record` (object)

  - `relations.updatedAt` (integer)
    Unix timestamp when the entity was last updated

  - `relations.updatedBy` (object)
    Identifier of the user who last updated the entity

  - `relations.updatedBy.name` (string, required)

  - `relations.updatedBy.label` (string)

  - `relations.updatedBy.createdAt` (integer)

  - `relations.updatedBy.updatedAt` (integer)

  - `relations.updatedBy.deletedAt` (integer)

  - `relations.updatedBy.createdByUuid` (string)

  - `relations.updatedBy.updatedByUuid` (string)

  - `relations.updatedBy.deletedByUuid` (string)

  - `relations.updatedBy.index` (integer)

  - `relations.updatedBy.deleted` (boolean)

  - `relations.updatedBy.complete` (boolean)

  - `relations.updatedBy.uuid` (string, required)

  - `relations.updatedBy.properties` (array)

  - `relations.updatedBy.properties.icon` (string)

  - `relations.updatedBy.properties.name` (string)

  - `relations.updatedBy.properties.value` (any)

  - `relations.updatedBy.properties.type` (string)

  - `relations.updatedBy.properties.label` (string)

  - `relations.updatedBy.objects` (object)

  - `relations.updatedBy.user` (object)

  - `relations.updatedBy.user.uuid` (string)

  - `relations.updatedBy.user.email` (string)

  - `relations.updatedBy.user.firstname` (string)

  - `relations.updatedBy.user.lastname` (string)

  - `relations.updatedBy.user.initials` (string)

  - `relations.updatedBy.user.scopes` (array)

  - `relations.updatedBy.user.filters` (object)

  - `relations.updatedBy.user.role` (string)

  - `relations.updatedBy.user.record` (object)

  - `relations.deletedAt` (integer)
    Unix timestamp when the entity was deleted (null if not deleted)

  - `relations.deletedBy` (object)
    Identifier of the user who deleted the entity

  - `relations.deletedBy.name` (string, required)

  - `relations.deletedBy.label` (string)

  - `relations.deletedBy.createdAt` (integer)

  - `relations.deletedBy.updatedAt` (integer)

  - `relations.deletedBy.deletedAt` (integer)

  - `relations.deletedBy.createdByUuid` (string)

  - `relations.deletedBy.updatedByUuid` (string)

  - `relations.deletedBy.deletedByUuid` (string)

  - `relations.deletedBy.index` (integer)

  - `relations.deletedBy.deleted` (boolean)

  - `relations.deletedBy.complete` (boolean)

  - `relations.deletedBy.uuid` (string, required)

  - `relations.deletedBy.properties` (array)

  - `relations.deletedBy.properties.icon` (string)

  - `relations.deletedBy.properties.name` (string)

  - `relations.deletedBy.properties.value` (any)

  - `relations.deletedBy.properties.type` (string)

  - `relations.deletedBy.properties.label` (string)

  - `relations.deletedBy.objects` (object)

  - `relations.deletedBy.user` (object)

  - `relations.deletedBy.user.uuid` (string)

  - `relations.deletedBy.user.email` (string)

  - `relations.deletedBy.user.firstname` (string)

  - `relations.deletedBy.user.lastname` (string)

  - `relations.deletedBy.user.initials` (string)

  - `relations.deletedBy.user.scopes` (array)

  - `relations.deletedBy.user.filters` (object)

  - `relations.deletedBy.user.role` (string)

  - `relations.deletedBy.user.record` (object)

  - `relations.index` (integer)
    Index number for ordering entities

  - `relations.description` (string)
    Detailed description of the relation's purpose and usage

  - `relations.objects` (array)
    Set of Caraer objects that are part of this relation

  - `relations.immutable` (boolean)
    Whether the relation is immutable

  - `relations.editable` (boolean)
    Whether the relation is editable

  - `suites` (array)
    List of suite names this object belongs to

  - `extendsTo` (array)
    List of objects this object extends to

## Response 200 fields (application/json):

  - `message` (string)
    A message detailing the result of the operation.
    Example: "Success"

  - `data` (any)
    The data payload of the response, if any.

## Response 400 fields (*/*):

  - `message` (string)
    The error message providing details about the failure.
    Example: "Resource not found."

  - `errors` (object)
    A list of error types providing further details about the error.
    Example: [{"field":"name","message":"Name is required.","correctionSuggestion":"Please provide a name."}]

  - `errors.message` (string, required)
    The error message providing details about the failure.
    Example: "Invalid file type."

  - `errors.type` (string, required)
    The type of error.
    Enum: "VALIDATION", "NOT_FOUND", "TEST", "RELATION_NOT_ALLOWED", "INVALID_VALUE", "GENERAL", "INVALID_FILE_TYPE", "INTERNAL_SERVER_ERROR", "CARAER_ERROR", "INVALID_EMAIL", "INVALID_DATE"

  - `errors.correctionSuggestion` (string, required)
    A suggestion on how to correct the error.
    Example: "Try uploading a different file type."

  - `status` (integer)
    The HTTP status code associated with the error.
    Example: 400

  - `stackTrace` (string)

  - `roles` (array)
    Enum: "USER", "ADMIN", "RESELLER", "DEVELOPER", "SUPER_ADMIN"

  - `scopes` (array)

## Response 404 fields (*/*):

  - `message` (string)
    The error message providing details about the failure.
    Example: "Resource not found."

  - `errors` (object)
    A list of error types providing further details about the error.
    Example: [{"field":"name","message":"Name is required.","correctionSuggestion":"Please provide a name."}]

  - `errors.message` (string, required)
    The error message providing details about the failure.
    Example: "Invalid file type."

  - `errors.type` (string, required)
    The type of error.
    Enum: "VALIDATION", "NOT_FOUND", "TEST", "RELATION_NOT_ALLOWED", "INVALID_VALUE", "GENERAL", "INVALID_FILE_TYPE", "INTERNAL_SERVER_ERROR", "CARAER_ERROR", "INVALID_EMAIL", "INVALID_DATE"

  - `errors.correctionSuggestion` (string, required)
    A suggestion on how to correct the error.
    Example: "Try uploading a different file type."

  - `status` (integer)
    The HTTP status code associated with the error.
    Example: 400

  - `stackTrace` (string)

  - `roles` (array)
    Enum: "USER", "ADMIN", "RESELLER", "DEVELOPER", "SUPER_ADMIN"

  - `scopes` (array)

## Response 500 fields (*/*):

  - `message` (string)
    The error message providing details about the failure.
    Example: "Resource not found."

  - `errors` (object)
    A list of error types providing further details about the error.
    Example: [{"field":"name","message":"Name is required.","correctionSuggestion":"Please provide a name."}]

  - `errors.message` (string, required)
    The error message providing details about the failure.
    Example: "Invalid file type."

  - `errors.type` (string, required)
    The type of error.
    Enum: "VALIDATION", "NOT_FOUND", "TEST", "RELATION_NOT_ALLOWED", "INVALID_VALUE", "GENERAL", "INVALID_FILE_TYPE", "INTERNAL_SERVER_ERROR", "CARAER_ERROR", "INVALID_EMAIL", "INVALID_DATE"

  - `errors.correctionSuggestion` (string, required)
    A suggestion on how to correct the error.
    Example: "Try uploading a different file type."

  - `status` (integer)
    The HTTP status code associated with the error.
    Example: 400

  - `stackTrace` (string)

  - `roles` (array)
    Enum: "USER", "ADMIN", "RESELLER", "DEVELOPER", "SUPER_ADMIN"

  - `scopes` (array)