# Update a sync

Updates an existing sync. Returns a UpdateResponse containing the updated sync details.

Endpoint: PUT /api/v2/sync/{uuid}
Version: 1.0
Security: BearerAuthentication

## Path parameters:

  - `uuid` (string, required)

## Request fields (application/json):

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

  - `name` (string, required)
    The name of the entity

  - `label` (string)

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

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

  - `createdBy.name` (string, required)

  - `createdBy.createdAt` (integer)

  - `createdBy.updatedAt` (integer)

  - `createdBy.deletedAt` (integer)

  - `createdBy.createdByUuid` (string)

  - `createdBy.updatedByUuid` (string)

  - `createdBy.deletedByUuid` (string)

  - `createdBy.index` (integer)

  - `createdBy.complete` (boolean)

  - `createdBy.deleted` (boolean)

  - `createdBy.uuid` (string, required)

  - `createdBy.objects` (object)

  - `createdBy.properties` (array)

  - `createdBy.properties.value` (any)

  - `createdBy.properties.type` (string)

  - `createdBy.properties.icon` (string)

  - `createdBy.user` (object)

  - `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

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

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

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

  - `mappings` (array)

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

  - `mappings.sourceUrl` (string)

  - `mappings.syncRate` (integer)

  - `mappings.active` (boolean)

  - `mappings.mappingItems` (array)

  - `mappings.mappingItems.sourceField` (string)

  - `mappings.mappingItems.targetObject` (object)
    Data transfer object representing a Caraer object with its configuration, properties, relations, and views

  - `mappings.mappingItems.targetObject.name` (string)
    Unique identifier name for the object

  - `mappings.mappingItems.targetObject.label` (string)
    Display label for the object

  - `mappings.mappingItems.targetObject.index` (integer)
    Index number for ordering objects

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

  - `mappings.mappingItems.targetObject.description` (string)
    Detailed description of the object's purpose and usage

  - `mappings.mappingItems.targetObject.groups` (array)
    Collection of group names this object belongs to

  - `mappings.mappingItems.targetObject.icon` (string)
    Icon identifier for visual representation of the object

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

  - `mappings.mappingItems.targetObject.defaultTrait` (string)
    Name of the default trait applied to this object

  - `mappings.mappingItems.targetObject.traits` (array)
    List of trait names associated with this object

  - `mappings.mappingItems.targetObject.views` (array)
    List of view configurations for displaying this object

  - `mappings.mappingItems.targetObject.views.favorite` (boolean)

  - `mappings.mappingItems.targetObject.views.team` (boolean)

  - `mappings.mappingItems.targetObject.views.shared` (boolean)

  - `mappings.mappingItems.targetObject.views.personal` (boolean)

  - `mappings.mappingItems.targetObject.views.trait` (string)

  - `mappings.mappingItems.targetObject.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.

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

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

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

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

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

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

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

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

  - `mappings.mappingItems.targetObject.views.shows` (array)

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

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

  - `mappings.mappingItems.targetObject.views.sorts` (array)

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

  - `mappings.mappingItems.targetObject.views.limit` (integer)

  - `mappings.mappingItems.targetObject.views.showIcons` (boolean)

  - `mappings.mappingItems.targetObject.views.groupProperty` (object)
    Represents a sortable item, including object, relation, property, and sort direction.

  - `mappings.mappingItems.targetObject.views.rowHeight` (string)

  - `mappings.mappingItems.targetObject.views.calculations` (array)

  - `mappings.mappingItems.targetObject.views.calculations.property` (object)
    DTO representing an item with properties defined for displaying and handling in UI related operations.

  - `mappings.mappingItems.targetObject.views.calculations.calculation` (string)

  - `mappings.mappingItems.targetObject.views.query` (string)

  - `mappings.mappingItems.targetObject.views.flowProperty` (string)

  - `mappings.mappingItems.targetObject.views.defaultView` (boolean)

  - `mappings.mappingItems.targetObject.views.isInternallyPublic` (boolean)

  - `mappings.mappingItems.targetObject.properties` (array)
    List of properties defined for this object

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

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

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

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

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

  - `mappings.mappingItems.targetObject.properties.options.color` (string)

  - `mappings.mappingItems.targetObject.properties.options.disabled` (boolean)

  - `mappings.mappingItems.targetObject.properties.options.usedIn` (object)

  - `mappings.mappingItems.targetObject.properties.options.usedIn.recordUuids` (array)

  - `mappings.mappingItems.targetObject.properties.options.usedIn.count` (integer)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `mappings.mappingItems.targetObject.properties.minAndMaxValue.t1` (integer)

  - `mappings.mappingItems.targetObject.properties.minAndMaxValue.t2` (integer)

  - `mappings.mappingItems.targetObject.relations` (array)
    List of relations this object has with other objects

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

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

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

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

  - `mappings.mappingItems.targetObject.suites` (array)
    List of suite names this object belongs to

  - `mappings.mappingItems.targetProperty` (object)
    Data transfer object representing a property with its configuration and metadata

  - `mappings.mappingItems.conversionFunction` (string)

  - `mappings.object` (object)
    Data transfer object representing a Caraer object with its configuration, properties, relations, and views

  - `mappings.unpublishWhenNotInSource` (boolean)

## 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 (application/json):

  - `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.correctionSuggestion` (string, required)
    A suggestion on how to correct the error.
    Example: "Try uploading a different 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"

  - `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 (application/json):

  - `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.correctionSuggestion` (string, required)
    A suggestion on how to correct the error.
    Example: "Try uploading a different 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"

  - `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)