---
updatedAt: 2026-05-27T10:25:03.000Z
agentTools:
  projectIndex: https://docs.v7labs.com/llms.txt
---

# Update property

  Updates property and adds property values for given team.


# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Annotations.Property.PropertyValuePosition": {
        "description": "Position of property value in list",
        "title": "Annotations.Property.PropertyValuePosition",
        "type": "integer",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.PropertyValuePosition",
        "x-validate": null
      },
      "Annotations.Property.UpdateRequest": {
        "additionalProperties": false,
        "description": "Update property request information.",
        "properties": {
          "dataset_ids": {
            "$ref": "#/components/schemas/Annotations.Property.DatasetIds"
          },
          "description": {
            "description": "Description of property",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "max_duration_seconds": {
            "$ref": "#/components/schemas/Annotations.Property.MaxDurationSeconds"
          },
          "min_duration_seconds": {
            "$ref": "#/components/schemas/Annotations.Property.MinDurationSeconds"
          },
          "name": {
            "description": "Name of property",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "property_values": {
            "description": "Property values",
            "items": {
              "$ref": "#/components/schemas/Annotations.Property.PropertyValue"
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          },
          "required": {
            "description": "Indicates if property is required",
            "type": "boolean",
            "x-struct": null,
            "x-validate": null
          },
          "type": {
            "$ref": "#/components/schemas/Annotations.Property.PropertyType"
          }
        },
        "required": [
          "name"
        ],
        "title": "Annotations.Property.UpdateRequest",
        "type": "object",
        "x-struct": null,
        "x-validate": null
      },
      "Annotations.Property.Color": {
        "description": "Color in rgba format",
        "title": "Annotations.Property.Color",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.Color",
        "x-validate": null
      },
      "Annotations.Property.DatasetIds": {
        "default": [],
        "description": "List of dataset ids associated with the property. Can be set only when `granularity` is `item`",
        "items": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null
        },
        "title": "Annotations.Property.DatasetIds",
        "type": "array",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.DatasetIds",
        "x-validate": null
      },
      "Annotations.Property.PropertyValueResponse": {
        "additionalProperties": false,
        "description": "Property value response",
        "properties": {
          "color": {
            "$ref": "#/components/schemas/Annotations.Property.Color"
          },
          "id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "position": {
            "$ref": "#/components/schemas/Annotations.Property.PropertyValuePosition"
          },
          "value": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          }
        },
        "required": [
          "id",
          "value",
          "color"
        ],
        "title": "Annotations.Property.PropertyValueResponse",
        "type": "object",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.PropertyValueResponse",
        "x-validate": null
      },
      "JsonErrorResponse": {
        "properties": {
          "errors": {
            "items": {
              "properties": {
                "detail": {
                  "example": "null value where string expected",
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                },
                "source": {
                  "properties": {
                    "pointer": {
                      "example": "/data/attributes/petName",
                      "type": "string",
                      "x-struct": null,
                      "x-validate": null
                    }
                  },
                  "required": [
                    "pointer"
                  ],
                  "type": "object",
                  "x-struct": null,
                  "x-validate": null
                },
                "title": {
                  "example": "Invalid value",
                  "type": "string",
                  "x-struct": null,
                  "x-validate": null
                }
              },
              "required": [
                "title",
                "source",
                "detail"
              ],
              "type": "object",
              "x-struct": null,
              "x-validate": null
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          }
        },
        "required": [
          "errors"
        ],
        "title": "JsonErrorResponse",
        "type": "object",
        "x-struct": "Elixir.OpenApiSpex.JsonErrorResponse",
        "x-validate": null
      },
      "Annotations.Property.PropertyResponse": {
        "additionalProperties": false,
        "allOf": [
          {
            "$ref": "#/components/schemas/Annotations.Property.Property"
          }
        ],
        "description": "Property response information.",
        "title": "Annotations.Property.PropertyResponse",
        "type": "object",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.PropertyResponse",
        "x-validate": null
      },
      "Annotations.Property.PropertyId": {
        "description": "Property UUID",
        "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
        "format": "uuid",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
        "title": "Annotations.Property.PropertyId",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.PropertyId",
        "x-validate": null
      },
      "Annotations.Property.MaxDurationSeconds": {
        "description": "Maximum recording duration in seconds. Only allowed on audio properties. Must be greater than 0 and at most 3600 (1 hour). Null means no upper bound; on update, an explicit null clears the bound while omitting the field leaves it unchanged.",
        "exclusiveMinimum": true,
        "maximum": 3600,
        "minimum": 0,
        "nullable": true,
        "title": "Annotations.Property.MaxDurationSeconds",
        "type": "number",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.MaxDurationSeconds",
        "x-validate": null
      },
      "Common.APIError": {
        "additionalProperties": false,
        "properties": {
          "errors": {
            "properties": {
              "code": {
                "enum": [
                  "OUT_OF_ANNOTATION_CREDITS",
                  "NOT_ARCHIVED",
                  "ASSIGN_WORKFLOW_TEMPLATE_UNAVAILABLE",
                  "REJECT_REASON_REQUIRED",
                  "WORKFLOW_UPDATE_FAILURE",
                  "GATED_FEATURE_SSO_AND_SAML",
                  "UPLOAD_DISABLED",
                  "ITEM_REGISTRATION_LIMIT_EXCEEDED",
                  "SSO_REQUIRED",
                  "TOO_MANY_PENDING_EXPORTS",
                  "STORAGE_VALIDATION_FAILED",
                  "INVALID_ITEM_LAYOUT",
                  "WORKFLOW_ALREADY_COMPLETE",
                  "SUBSCRIPTION_INCOMPLETE_EXPIRED",
                  "UNIQUE_CONSTRAINT_VIOLATION",
                  "ITEM_IS_NOT_READY_FOR_ANNOTATIONS_IMPORT",
                  "REPORT_TOO_LARGE",
                  "NO_EXTERNAL_STORAGE_SET_FOR_TEAM",
                  "NO_DEFAULT_WORKFLOW",
                  "PLATFORM_TFA_ENFORCEMENT_LOCKED",
                  "STORAGE_LIMIT_REACHED",
                  "FEATURE_FLAG_DISABLED",
                  "MISSING_FILE_TYPE",
                  "DUPLICATED_FILE_SLOT",
                  "NO_AVAILABLE_WORK",
                  "INVALID_REJECT_REASONS",
                  "MODIFYING_COMPLETE_STAGE",
                  "ENFORCING_SSO_BLOCKS_REGULAR_MEMBERSHIPS",
                  "INVALID_SAML_REQUEST",
                  "MISSING_PARAMETERS",
                  "INCORRECT_CLASS_USAGE",
                  "GROUND_TRUTH_NAME_DUPLICATE",
                  "NOT_AUTHENTICATED",
                  "TOO_MANY_ACTIVE_REPORT_JOBS",
                  "NOT_CURRENT_STAGE",
                  "INVALID_2FA_TOKEN",
                  "DATASET_IN_WORKFLOW",
                  "INCOMPATIBLE_STAGE_TYPE",
                  "STAGE_HISTORY_REQUIRES_DARWIN_JSON",
                  "TARGET_IN_DIFFERENT_DATASET",
                  "ASSIGN_ASSIGNMENT_INVALID",
                  "INVALID_ANNOTATION_DATA",
                  "OUT_OF_SEATS",
                  "STAGE_MISSING_ASSIGNEE",
                  "NO_ANNOTATIONS_ON_SOURCE_ITEM",
                  "REVIEW_STATUS_NOT_SET",
                  "NOT_FOUND",
                  "TOO_MANY_REJECT_REASONS",
                  "SUBSCRIPTION_PAST_DUE",
                  "EXTERNAL_STORAGE_LIMIT_REACHED",
                  "UNPROCESSED_VIDEO_REGISTRATION_DISABLED",
                  "GATED_FEATURE_TFA_ENFORCEMENT",
                  "NO_ACTIVE_WORKFLOW",
                  "USER_NOT_FOUND_FOR_ACTOR",
                  "GROUND_TRUTH_VERSIONING_NOT_SUPPORTED",
                  "CLASSES_USED_IN_WORKFLOW",
                  "DUPLICATED_OBJECT_REJECTED",
                  "SUBSCRIPTION_UNPAID",
                  "MULTIBITRATE_STREAM_NOT_AVAILABLE",
                  "TIMEOUT",
                  "TARGET_STAGE_NOT_CURRENT",
                  "BAD_REQUEST",
                  "MULTIPLE_SLOTS_IN_AS_FRAMES_MODE",
                  "INCLUDES_RASTER_LAYER",
                  "OUT_OF_SUBSCRIBED_STORAGE",
                  "REPORT_JOB_NOT_FINISHED",
                  "ASSIGN_ATTRIBUTES_INVALID",
                  "NOT_AUTHORIZED",
                  "SUBSCRIPTION_CANCELLED",
                  "DATASET_ERROR",
                  "STORAGE_NOT_FOUND",
                  "NO_WORKSPACES_AVAILABLE",
                  "TARGET_REVIEW_STAGE_READONLY",
                  "TOO_MANY_ATTEMPTS",
                  "OUT_OF_SUBSCRIBED_ANNOTATION_CREDITS",
                  "SSO_SIGNUP_REQUIRED",
                  "TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS",
                  "NOTHING_TO_EXPORT",
                  "INVALID_REJECT_REASON",
                  "TARGET_STAGE_TYPE_INVALID",
                  "PAYMENT_NOT_SETUP",
                  "AWS_MARKETPLACE_FULFILLMENT_INCOMPLETE",
                  "MISSING_SELECT_ALL_FILTER",
                  "DUPLICATED_ITEM_FULL_PATH",
                  "UPLOAD_VIDEO_READONLY_STORAGE_MISSING_FRAME_SPECS",
                  "DUPLICATE_REJECT_REASON",
                  "PATH_ALREADY_TAKEN",
                  "TARGET_ALREADY_ANNOTATED",
                  "FILTER_VALIDATION_ERROR",
                  "OPERATION_ALREADY_IN_PROGRESS",
                  "DATASET_NOT_FOUND",
                  "EXTERNAL_STORAGE_ACCESS_FAILED",
                  "INVALID_URL",
                  "ALREADY_IN_WORKFLOW",
                  "ASSIGN_NOT_ALL_ITEMS_ASSIGNABLE",
                  "INCOMPATIBLE_DATASET_VERSION",
                  "ALREADY_HAS_ANNOTATIONS",
                  "BILLING_ADDRESS_INFO_MISSING",
                  "INVALID_REQUEST",
                  "GATED_FEATURE_EXTERNAL_MODEL_REGISTRATION"
                ],
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "detail": {
                "nullable": true,
                "type": "object",
                "x-struct": null,
                "x-validate": null
              },
              "message": {
                "example": "Error message",
                "nullable": true,
                "type": "string",
                "x-struct": null,
                "x-validate": null
              },
              "status": {
                "example": 422,
                "nullable": false,
                "type": "integer",
                "x-struct": null,
                "x-validate": null
              }
            },
            "required": [
              "message"
            ],
            "type": "object",
            "x-struct": null,
            "x-validate": null
          }
        },
        "required": [
          "errors"
        ],
        "title": "Common.APIError",
        "type": "object",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Common.APIError",
        "x-validate": null
      },
      "Common.DateTime": {
        "description": "DateTime in RFC3339 format",
        "example": "2020-01-20T14:00:00Z",
        "format": "date-time",
        "title": "Common.DateTime",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Common.DateTime",
        "x-validate": null
      },
      "Annotations.Property.TriggerCondition": {
        "additionalProperties": false,
        "description": "Trigger condition that determines when a child property becomes visible. Null for top-level properties. Otherwise either {\"type\": \"any_value\"} or {\"type\": \"value_match\", \"property_value_ids\": [...]}",
        "nullable": true,
        "properties": {
          "property_value_ids": {
            "description": "List of property value IDs that trigger visibility (only for value_match)",
            "items": {
              "format": "uuid",
              "type": "string",
              "x-struct": null,
              "x-validate": null
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          },
          "type": {
            "description": "Type of trigger condition",
            "enum": [
              "any_value",
              "value_match"
            ],
            "type": "string",
            "x-struct": null,
            "x-validate": null
          }
        },
        "required": [
          "type"
        ],
        "title": "Annotations.Property.TriggerCondition",
        "type": "object",
        "x-struct": null,
        "x-validate": null
      },
      "Annotations.Property.PropertyValueType": {
        "default": "string",
        "enum": [
          "string"
        ],
        "title": "Annotations.Property.PropertyValueType",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.PropertyValueType",
        "x-validate": null
      },
      "Annotations.Property.MinDurationSeconds": {
        "description": "Minimum recording duration in seconds. Only allowed on audio properties. Must be greater than 0, at most 3600 (1 hour), and not exceed max_duration_seconds. Null means no lower bound; on update, an explicit null clears the bound while omitting the field leaves it unchanged.",
        "exclusiveMinimum": true,
        "maximum": 3600,
        "minimum": 0,
        "nullable": true,
        "title": "Annotations.Property.MinDurationSeconds",
        "type": "number",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.MinDurationSeconds",
        "x-validate": null
      },
      "Annotations.Property.PropertyValue": {
        "additionalProperties": false,
        "description": "Property value request",
        "properties": {
          "color": {
            "$ref": "#/components/schemas/Annotations.Property.Color"
          },
          "type": {
            "$ref": "#/components/schemas/Annotations.Property.PropertyValueType"
          },
          "value": {
            "$ref": "#/components/schemas/Annotations.Property.Value"
          }
        },
        "required": [
          "value",
          "color"
        ],
        "title": "Annotations.Property.PropertyValue",
        "type": "object",
        "x-struct": null,
        "x-validate": null
      },
      "Annotations.Property.Value": {
        "title": "Annotations.Property.Value",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.Value",
        "x-validate": null
      },
      "Annotations.Property.Property": {
        "additionalProperties": false,
        "description": "Property information.",
        "properties": {
          "annotation_class_id": {
            "description": "Annotation class id",
            "nullable": true,
            "type": "integer",
            "x-struct": null,
            "x-validate": null
          },
          "dataset_ids": {
            "$ref": "#/components/schemas/Annotations.Property.DatasetIds"
          },
          "description": {
            "description": "Description of property",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "granularity": {
            "$ref": "#/components/schemas/Annotations.Property.PropertyGranularity"
          },
          "id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "inserted_at": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "max_duration_seconds": {
            "$ref": "#/components/schemas/Annotations.Property.MaxDurationSeconds"
          },
          "min_duration_seconds": {
            "$ref": "#/components/schemas/Annotations.Property.MinDurationSeconds"
          },
          "name": {
            "description": "Name of property",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "parent_property_id": {
            "description": "UUID of the parent property. Null for top-level properties.",
            "format": "uuid",
            "nullable": true,
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "position": {
            "description": "Position of property in list",
            "nullable": true,
            "type": "integer",
            "x-struct": null,
            "x-validate": null
          },
          "property_values": {
            "description": "Property values",
            "items": {
              "$ref": "#/components/schemas/Annotations.Property.PropertyValueResponse"
            },
            "type": "array",
            "x-struct": null,
            "x-validate": null
          },
          "required": {
            "description": "Indicates if property is required",
            "type": "boolean",
            "x-struct": null,
            "x-validate": null
          },
          "slug": {
            "description": "Name's slug of property",
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "team_id": {
            "description": "Team id",
            "type": "integer",
            "x-struct": null,
            "x-validate": null
          },
          "trigger_condition": {
            "$ref": "#/components/schemas/Annotations.Property.TriggerCondition"
          },
          "type": {
            "$ref": "#/components/schemas/Annotations.Property.PropertyType"
          }
        },
        "required": [
          "id",
          "name",
          "slug",
          "team_id",
          "annotation_class_id",
          "required",
          "type",
          "granularity",
          "dataset_ids",
          "inserted_at"
        ],
        "title": "Annotations.Property.Property",
        "type": "object",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.Property",
        "x-validate": null
      },
      "Annotations.Property.PropertyGranularity": {
        "default": "section",
        "enum": [
          "item",
          "annotation",
          "section"
        ],
        "title": "Annotations.Property.PropertyGranularity",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.PropertyGranularity",
        "x-validate": null
      },
      "Annotations.Property.PropertyType": {
        "enum": [
          "single_select",
          "multi_select",
          "boolean",
          "text",
          "audio"
        ],
        "title": "Annotations.Property.PropertyType",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Annotations.Property.PropertyType",
        "x-validate": null
      },
      "Common.UUID": {
        "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
        "format": "uuid",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
        "title": "Common.UUID",
        "type": "string",
        "x-struct": "Elixir.GraphotateWeb.Schemas.Common.UUID",
        "x-validate": null
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "description": "Prefix the value with 'ApiKey '.",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      },
      "BearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Darwin",
    "version": "1.0"
  },
  "openapi": "3.0.0",
  "paths": {
    "/api/v2/teams/{team_slug}/properties/{id}": {
      "put": {
        "callbacks": {},
        "description": "  Updates property and adds property values for given team.\n",
        "operationId": "property-update",
        "parameters": [
          {
            "description": "Team's sluggified name",
            "example": "my-team",
            "in": "path",
            "name": "team_slug",
            "required": true,
            "schema": {
              "type": "string",
              "x-struct": null,
              "x-validate": null
            }
          },
          {
            "description": "Property UUID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Annotations.Property.PropertyId"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Annotations.Property.UpdateRequest"
              }
            }
          },
          "description": "Annotations.Property.UpdateRequest",
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Annotations.Property.PropertyResponse"
                }
              }
            },
            "description": "Annotations.Property.PropertyResponse"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/JsonErrorResponse"
                    },
                    {
                      "$ref": "#/components/schemas/Common.APIError"
                    }
                  ],
                  "x-struct": null,
                  "x-validate": null
                }
              }
            },
            "description": "Unprocessible Entity"
          }
        },
        "summary": "Update property",
        "tags": [
          "Properties"
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    },
    {
      "ApiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://darwin.v7labs.com",
      "variables": {}
    }
  ]
}
```