> For the complete documentation index, see [llms.txt](https://help.csvbox.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.csvbox.io/advanced-installation/sheet-api.md).

# Sheet API

## Create Sheet

> Creates a new sheet importer.

```json
{"openapi":"3.0.0","info":{"title":"CSVBox Sheets API Documentation","version":"1.1.0"},"tags":[{"name":"Sheets","description":"Sheets"}],"servers":[{"url":"https://api.csvbox.io/","description":"CSVBox Sheets API Server"}],"security":[{"ApiKeyAuth":[],"ApiSecretKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"x-csvbox-api-key","in":"header"}},"parameters":{"AcceptHeader":{"name":"Accept","in":"header","description":"Must be application/json","required":true,"schema":{"type":"string"}},"ContentTypeHeader":{"name":"Content-Type","in":"header","description":"Content type must be application/json","required":true,"schema":{"type":"string"}}},"schemas":{"CreateSheetRequest":{"required":["title"],"properties":{"title":{"type":"string"},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/Destinations"}},"sheet_columns":{"type":"array","items":{"$ref":"#/components/schemas/SheetColumn"}},"steps":{"$ref":"#/components/schemas/Steps"},"security_settings":{"$ref":"#/components/schemas/SecuritySettings"}},"type":"object"},"Webhook":{"properties":{"import_complete":{"$ref":"#/components/schemas/WebhookImportComplete"}},"type":"object"},"WebhookImportComplete":{"properties":{"url":{"type":"string","format":"url"},"send_copy":{"description":"Send a copy of imported data to client","type":"boolean"},"custom_headers":{"type":"array","items":{"$ref":"#/components/schemas/Header"}}},"type":"object"},"Header":{"required":["key","value"],"properties":{"key":{"description":"---------------------------------------------------------\nHEADER OBJECT\n---------------------------------------------------------","type":"string"},"value":{"type":"string"}},"type":"object"},"Destinations":{"properties":{"type":{"type":"string","enum":["webhook","testapi","none"]},"isActive":{"type":"boolean"},"settings":{"properties":{"method":{"type":"string","enum":["POST","PATCH"]},"url":{"type":"string","format":"url"},"post_data_format":{"type":"string","enum":["JSON","FORM_DATA","XML"]},"rows_per_chunk":{"type":"integer"},"request_type":{"type":"string","enum":["parallel","sequential"]},"server_side_validation":{"type":"boolean"},"allow_resubmit":{"type":"string","enum":["all_rows","error_rows_only"]},"custom_headers":{"type":"array","items":{"$ref":"#/components/schemas/Header"}}},"type":"object"}},"type":"object"},"SheetColumn":{"required":["column_name"],"properties":{"column_name":{"type":"string"},"display_label":{"type":"string"},"info_hint":{"type":"string"},"matching_keywords":{"type":"string"},"type":{"type":"string","enum":["text","number","email","date","time","boolean","regex","ip","url","credit_card","phone_number","currency","list","dependent_list","dynamic_list","dependent_dynamic_list","multiselect_list","multiselect_dynamic_list"]},"default_value":{"type":"string"},"required":{"type":"boolean"},"read_only":{"type":"boolean"},"position":{"type":"integer","minimum":1},"validators":{"description":"Validators depend on the column type. See examples below for each type.","properties":{"min_length":{"description":"[text] Minimum character length","type":"integer"},"max_length":{"description":"[text] Maximum character length","type":"integer"},"min_value":{"description":"[number] Minimum numeric value","type":"number"},"max_value":{"description":"[number] Maximum numeric value","type":"number"},"format":{"description":"[date] Date format e.g. YYYY-MM-DD | [time] Time format e.g. HH:mm:ss","type":"string"},"expression":{"description":"[regex] Regular expression pattern","type":"string"},"error_message":{"description":"[regex] Custom error message","type":"string"},"version":{"description":"[ip] IP version","type":"string","enum":["ipv4","ipv6"]},"country_code":{"description":"[phone_number] Country code e.g. IN, US","type":"string"},"symbol":{"description":"[currency] Currency symbol","type":"string"},"require_symbol":{"description":"[currency] Whether symbol is required","type":"boolean"},"values":{"description":"[list] Array of ListItem objects (with dependents) | [multiselect_list] Array of strings","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},{"type":"array","items":{"type":"string"}}]},"case_sensitive":{"description":"[list, multiselect_list] Case-sensitive matching","type":"boolean"},"primary_column":{"description":"[dependent_list, dependent_dynamic_list] The column_name of the parent list column","type":"string"},"source_url":{"description":"[dynamic_list, multiselect_dynamic_list] URL to fetch list options from","type":"string"},"request_method":{"description":"[dynamic_list, multiselect_dynamic_list] HTTP method","type":"string","enum":["GET","POST"]},"request_headers":{"description":"[dynamic_list, multiselect_dynamic_list] Custom request headers","type":"array","items":{"$ref":"#/components/schemas/Header"}},"custom_user_attributes":{"description":"[dynamic_list] Include custom user attributes in request","type":"boolean"},"other_values":{"description":"[dynamic_list, multiselect_list, multiselect_dynamic_list] Allow values outside predefined list","type":"boolean"},"delimiter":{"description":"[multiselect_list, multiselect_dynamic_list] Delimiter for multiple values","type":"string"}},"type":"object"}},"type":"object"},"ListItem":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"},"dependents":{"type":"array","items":{"$ref":"#/components/schemas/ListItemChild"}}},"type":"object"},"ListItemChild":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"},"dependents":{"type":"array","items":{"$ref":"#/components/schemas/ListItemDependent"}}},"type":"object"},"ListItemDependent":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"}},"type":"object"},"Steps":{"properties":{"file_upload":{"properties":{"types":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"help":{"type":"string"},"sample_file_url":{"type":"string"},"size_mb":{"type":"integer"},"validation_msg":{"type":"string"},"copy_paste":{"type":"boolean"},"copy_delimiter":{"type":"string"},"show_upload":{"type":"boolean"},"worksheet_select":{"type":"boolean"},"description_option":{"type":"boolean"},"lang":{"type":"string"},"excel_date_format":{"type":"string"},"excel_date_custom":{"type":"string"},"hide_cancel":{"type":"boolean"},"split":{"description":"Split large files into multiple imports","type":"boolean"},"split_rows":{"description":"Rows per import when splitting (min 1)","type":"integer"},"split_confirm":{"description":"User confirmation required after each import: no=0, yes=1, no_if_no_errors=2","type":"string","enum":["no","yes","no_if_no_errors"]},"extract_types":{"description":"Allowed document extraction types (mapped to .pdf/.doc/images)","type":"array","items":{"type":"string","enum":["pdf","docs","images"]}},"page_limit":{"description":"Max pages allowed for extraction (null = no limit)","type":"integer","nullable":true}},"type":"object"},"select_header":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"default_row":{"type":"string"},"encoding_option":{"type":"boolean"},"encoding":{"type":"string"},"row_column_switch":{"type":"boolean"}},"type":"object"},"map_columns":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"mapping_mode":{"type":"string"},"bulk_cols_dd":{"type":"boolean"},"accept_unmapped":{"type":"boolean"},"accept_unmapped_select":{"type":"boolean"},"allow_zero_template":{"type":"boolean"},"ignore_cols":{"type":"boolean"},"ignore_cols_default":{"type":"boolean"},"user_keywords":{"type":"boolean"}},"type":"object"},"verify_data":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"row_display_mode":{"type":"string"},"export_option":{"type":"boolean"},"search_option":{"type":"boolean"},"ai_transform":{"type":"boolean"},"allow_new_rows":{"type":"boolean"},"rows_display":{"type":"integer"},"allow_invalid":{"type":"boolean"},"invalid_confirmation":{"type":"boolean"},"max_rows":{"type":"integer"},"allow_upload_if_max":{"type":"boolean"},"max_rows_msg":{"type":"string"},"min_rows":{"type":"integer"},"min_rows_msg":{"type":"string"}},"type":"object"},"results":{"properties":{"close_mode":{"type":"string"},"redirect_url":{"type":"string"},"success_type":{"type":"string"},"success_text":{"type":"string"},"success_method":{"type":"string"},"success_url":{"type":"string"},"failed_type":{"type":"string"},"failed_text":{"type":"string"},"failed_method":{"type":"string"},"failed_url":{"type":"string"},"show_resubmit":{"type":"boolean"},"show_error_text":{"type":"boolean"}},"type":"object"}},"type":"object"},"SecuritySettings":{"properties":{"region":{"type":"string","enum":["us","eu"]},"domains":{"type":"array","items":{"type":"string"}},"import_url_upload":{"type":"boolean"},"s3_upload":{"type":"boolean"}},"type":"object"},"SheetSuccessResponse":{"properties":{"status":{"type":"string"},"data":{"properties":{"sheet_license_key":{"type":"string"},"title":{"type":"string"}},"type":"object"}},"type":"object"},"ErrorResponse":{"properties":{"status":{"type":"string"},"errors":{"type":"object"}},"type":"object"}}},"paths":{"/1.1/sheet":{"post":{"tags":["Sheets"],"summary":"Create Sheet","description":"Creates a new sheet importer.","operationId":"createSheet","parameters":[{"$ref":"#/components/parameters/AcceptHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSheetRequest"}}}},"responses":{"201":{"description":"Sheet Created Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetSuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Update Sheet

> Fully updates an existing sheet. All provided fields will overwrite existing values.

```json
{"openapi":"3.0.0","info":{"title":"CSVBox Sheets API Documentation","version":"1.1.0"},"tags":[{"name":"Sheets","description":"Sheets"}],"servers":[{"url":"https://api.csvbox.io/","description":"CSVBox Sheets API Server"}],"security":[{"ApiKeyAuth":[],"ApiSecretKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"x-csvbox-api-key","in":"header"}},"parameters":{"AcceptHeader":{"name":"Accept","in":"header","description":"Must be application/json","required":true,"schema":{"type":"string"}},"ContentTypeHeader":{"name":"Content-Type","in":"header","description":"Content type must be application/json","required":true,"schema":{"type":"string"}}},"schemas":{"PutSheetRequest":{"properties":{"title":{"type":"string"},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/Destinations"}},"sheet_columns":{"type":"array","items":{"$ref":"#/components/schemas/SheetColumn"}},"steps":{"$ref":"#/components/schemas/Steps"},"security_settings":{"$ref":"#/components/schemas/SecuritySettings"}},"type":"object"},"Webhook":{"properties":{"import_complete":{"$ref":"#/components/schemas/WebhookImportComplete"}},"type":"object"},"WebhookImportComplete":{"properties":{"url":{"type":"string","format":"url"},"send_copy":{"description":"Send a copy of imported data to client","type":"boolean"},"custom_headers":{"type":"array","items":{"$ref":"#/components/schemas/Header"}}},"type":"object"},"Header":{"required":["key","value"],"properties":{"key":{"description":"---------------------------------------------------------\nHEADER OBJECT\n---------------------------------------------------------","type":"string"},"value":{"type":"string"}},"type":"object"},"Destinations":{"properties":{"type":{"type":"string","enum":["webhook","testapi","none"]},"isActive":{"type":"boolean"},"settings":{"properties":{"method":{"type":"string","enum":["POST","PATCH"]},"url":{"type":"string","format":"url"},"post_data_format":{"type":"string","enum":["JSON","FORM_DATA","XML"]},"rows_per_chunk":{"type":"integer"},"request_type":{"type":"string","enum":["parallel","sequential"]},"server_side_validation":{"type":"boolean"},"allow_resubmit":{"type":"string","enum":["all_rows","error_rows_only"]},"custom_headers":{"type":"array","items":{"$ref":"#/components/schemas/Header"}}},"type":"object"}},"type":"object"},"SheetColumn":{"required":["column_name"],"properties":{"column_name":{"type":"string"},"display_label":{"type":"string"},"info_hint":{"type":"string"},"matching_keywords":{"type":"string"},"type":{"type":"string","enum":["text","number","email","date","time","boolean","regex","ip","url","credit_card","phone_number","currency","list","dependent_list","dynamic_list","dependent_dynamic_list","multiselect_list","multiselect_dynamic_list"]},"default_value":{"type":"string"},"required":{"type":"boolean"},"read_only":{"type":"boolean"},"position":{"type":"integer","minimum":1},"validators":{"description":"Validators depend on the column type. See examples below for each type.","properties":{"min_length":{"description":"[text] Minimum character length","type":"integer"},"max_length":{"description":"[text] Maximum character length","type":"integer"},"min_value":{"description":"[number] Minimum numeric value","type":"number"},"max_value":{"description":"[number] Maximum numeric value","type":"number"},"format":{"description":"[date] Date format e.g. YYYY-MM-DD | [time] Time format e.g. HH:mm:ss","type":"string"},"expression":{"description":"[regex] Regular expression pattern","type":"string"},"error_message":{"description":"[regex] Custom error message","type":"string"},"version":{"description":"[ip] IP version","type":"string","enum":["ipv4","ipv6"]},"country_code":{"description":"[phone_number] Country code e.g. IN, US","type":"string"},"symbol":{"description":"[currency] Currency symbol","type":"string"},"require_symbol":{"description":"[currency] Whether symbol is required","type":"boolean"},"values":{"description":"[list] Array of ListItem objects (with dependents) | [multiselect_list] Array of strings","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},{"type":"array","items":{"type":"string"}}]},"case_sensitive":{"description":"[list, multiselect_list] Case-sensitive matching","type":"boolean"},"primary_column":{"description":"[dependent_list, dependent_dynamic_list] The column_name of the parent list column","type":"string"},"source_url":{"description":"[dynamic_list, multiselect_dynamic_list] URL to fetch list options from","type":"string"},"request_method":{"description":"[dynamic_list, multiselect_dynamic_list] HTTP method","type":"string","enum":["GET","POST"]},"request_headers":{"description":"[dynamic_list, multiselect_dynamic_list] Custom request headers","type":"array","items":{"$ref":"#/components/schemas/Header"}},"custom_user_attributes":{"description":"[dynamic_list] Include custom user attributes in request","type":"boolean"},"other_values":{"description":"[dynamic_list, multiselect_list, multiselect_dynamic_list] Allow values outside predefined list","type":"boolean"},"delimiter":{"description":"[multiselect_list, multiselect_dynamic_list] Delimiter for multiple values","type":"string"}},"type":"object"}},"type":"object"},"ListItem":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"},"dependents":{"type":"array","items":{"$ref":"#/components/schemas/ListItemChild"}}},"type":"object"},"ListItemChild":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"},"dependents":{"type":"array","items":{"$ref":"#/components/schemas/ListItemDependent"}}},"type":"object"},"ListItemDependent":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"}},"type":"object"},"Steps":{"properties":{"file_upload":{"properties":{"types":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"help":{"type":"string"},"sample_file_url":{"type":"string"},"size_mb":{"type":"integer"},"validation_msg":{"type":"string"},"copy_paste":{"type":"boolean"},"copy_delimiter":{"type":"string"},"show_upload":{"type":"boolean"},"worksheet_select":{"type":"boolean"},"description_option":{"type":"boolean"},"lang":{"type":"string"},"excel_date_format":{"type":"string"},"excel_date_custom":{"type":"string"},"hide_cancel":{"type":"boolean"},"split":{"description":"Split large files into multiple imports","type":"boolean"},"split_rows":{"description":"Rows per import when splitting (min 1)","type":"integer"},"split_confirm":{"description":"User confirmation required after each import: no=0, yes=1, no_if_no_errors=2","type":"string","enum":["no","yes","no_if_no_errors"]},"extract_types":{"description":"Allowed document extraction types (mapped to .pdf/.doc/images)","type":"array","items":{"type":"string","enum":["pdf","docs","images"]}},"page_limit":{"description":"Max pages allowed for extraction (null = no limit)","type":"integer","nullable":true}},"type":"object"},"select_header":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"default_row":{"type":"string"},"encoding_option":{"type":"boolean"},"encoding":{"type":"string"},"row_column_switch":{"type":"boolean"}},"type":"object"},"map_columns":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"mapping_mode":{"type":"string"},"bulk_cols_dd":{"type":"boolean"},"accept_unmapped":{"type":"boolean"},"accept_unmapped_select":{"type":"boolean"},"allow_zero_template":{"type":"boolean"},"ignore_cols":{"type":"boolean"},"ignore_cols_default":{"type":"boolean"},"user_keywords":{"type":"boolean"}},"type":"object"},"verify_data":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"row_display_mode":{"type":"string"},"export_option":{"type":"boolean"},"search_option":{"type":"boolean"},"ai_transform":{"type":"boolean"},"allow_new_rows":{"type":"boolean"},"rows_display":{"type":"integer"},"allow_invalid":{"type":"boolean"},"invalid_confirmation":{"type":"boolean"},"max_rows":{"type":"integer"},"allow_upload_if_max":{"type":"boolean"},"max_rows_msg":{"type":"string"},"min_rows":{"type":"integer"},"min_rows_msg":{"type":"string"}},"type":"object"},"results":{"properties":{"close_mode":{"type":"string"},"redirect_url":{"type":"string"},"success_type":{"type":"string"},"success_text":{"type":"string"},"success_method":{"type":"string"},"success_url":{"type":"string"},"failed_type":{"type":"string"},"failed_text":{"type":"string"},"failed_method":{"type":"string"},"failed_url":{"type":"string"},"show_resubmit":{"type":"boolean"},"show_error_text":{"type":"boolean"}},"type":"object"}},"type":"object"},"SecuritySettings":{"properties":{"region":{"type":"string","enum":["us","eu"]},"domains":{"type":"array","items":{"type":"string"}},"import_url_upload":{"type":"boolean"},"s3_upload":{"type":"boolean"}},"type":"object"},"SheetSuccessResponse":{"properties":{"status":{"type":"string"},"data":{"properties":{"sheet_license_key":{"type":"string"},"title":{"type":"string"}},"type":"object"}},"type":"object"},"ErrorResponse":{"properties":{"status":{"type":"string"},"errors":{"type":"object"}},"type":"object"}}},"paths":{"/1.1/sheet/{sheet_license_key}":{"put":{"tags":["Sheets"],"summary":"Update Sheet","description":"Fully updates an existing sheet. All provided fields will overwrite existing values.","operationId":"updateSheet","parameters":[{"name":"sheet_license_key","in":"path","description":"Sheet License Key","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AcceptHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutSheetRequest"}}}},"responses":{"200":{"description":"Sheet Updated Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetSuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Sheet Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Partially Update Sheet

> Partially updates an existing sheet. Only provided fields will be updated. Fields not included will remain unchanged.

```json
{"openapi":"3.0.0","info":{"title":"CSVBox Sheets API Documentation","version":"1.1.0"},"tags":[{"name":"Sheets","description":"Sheets"}],"servers":[{"url":"https://api.csvbox.io/","description":"CSVBox Sheets API Server"}],"security":[{"ApiKeyAuth":[],"ApiSecretKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"x-csvbox-api-key","in":"header"}},"parameters":{"AcceptHeader":{"name":"Accept","in":"header","description":"Must be application/json","required":true,"schema":{"type":"string"}},"ContentTypeHeader":{"name":"Content-Type","in":"header","description":"Content type must be application/json","required":true,"schema":{"type":"string"}}},"schemas":{"PatchSheetRequest":{"properties":{"title":{"type":"string"},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/Destinations"}},"sheet_columns":{"type":"array","items":{"$ref":"#/components/schemas/SheetColumn"}},"steps":{"$ref":"#/components/schemas/Steps"},"security_settings":{"$ref":"#/components/schemas/SecuritySettings"}},"type":"object"},"Webhook":{"properties":{"import_complete":{"$ref":"#/components/schemas/WebhookImportComplete"}},"type":"object"},"WebhookImportComplete":{"properties":{"url":{"type":"string","format":"url"},"send_copy":{"description":"Send a copy of imported data to client","type":"boolean"},"custom_headers":{"type":"array","items":{"$ref":"#/components/schemas/Header"}}},"type":"object"},"Header":{"required":["key","value"],"properties":{"key":{"description":"---------------------------------------------------------\nHEADER OBJECT\n---------------------------------------------------------","type":"string"},"value":{"type":"string"}},"type":"object"},"Destinations":{"properties":{"type":{"type":"string","enum":["webhook","testapi","none"]},"isActive":{"type":"boolean"},"settings":{"properties":{"method":{"type":"string","enum":["POST","PATCH"]},"url":{"type":"string","format":"url"},"post_data_format":{"type":"string","enum":["JSON","FORM_DATA","XML"]},"rows_per_chunk":{"type":"integer"},"request_type":{"type":"string","enum":["parallel","sequential"]},"server_side_validation":{"type":"boolean"},"allow_resubmit":{"type":"string","enum":["all_rows","error_rows_only"]},"custom_headers":{"type":"array","items":{"$ref":"#/components/schemas/Header"}}},"type":"object"}},"type":"object"},"SheetColumn":{"required":["column_name"],"properties":{"column_name":{"type":"string"},"display_label":{"type":"string"},"info_hint":{"type":"string"},"matching_keywords":{"type":"string"},"type":{"type":"string","enum":["text","number","email","date","time","boolean","regex","ip","url","credit_card","phone_number","currency","list","dependent_list","dynamic_list","dependent_dynamic_list","multiselect_list","multiselect_dynamic_list"]},"default_value":{"type":"string"},"required":{"type":"boolean"},"read_only":{"type":"boolean"},"position":{"type":"integer","minimum":1},"validators":{"description":"Validators depend on the column type. See examples below for each type.","properties":{"min_length":{"description":"[text] Minimum character length","type":"integer"},"max_length":{"description":"[text] Maximum character length","type":"integer"},"min_value":{"description":"[number] Minimum numeric value","type":"number"},"max_value":{"description":"[number] Maximum numeric value","type":"number"},"format":{"description":"[date] Date format e.g. YYYY-MM-DD | [time] Time format e.g. HH:mm:ss","type":"string"},"expression":{"description":"[regex] Regular expression pattern","type":"string"},"error_message":{"description":"[regex] Custom error message","type":"string"},"version":{"description":"[ip] IP version","type":"string","enum":["ipv4","ipv6"]},"country_code":{"description":"[phone_number] Country code e.g. IN, US","type":"string"},"symbol":{"description":"[currency] Currency symbol","type":"string"},"require_symbol":{"description":"[currency] Whether symbol is required","type":"boolean"},"values":{"description":"[list] Array of ListItem objects (with dependents) | [multiselect_list] Array of strings","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},{"type":"array","items":{"type":"string"}}]},"case_sensitive":{"description":"[list, multiselect_list] Case-sensitive matching","type":"boolean"},"primary_column":{"description":"[dependent_list, dependent_dynamic_list] The column_name of the parent list column","type":"string"},"source_url":{"description":"[dynamic_list, multiselect_dynamic_list] URL to fetch list options from","type":"string"},"request_method":{"description":"[dynamic_list, multiselect_dynamic_list] HTTP method","type":"string","enum":["GET","POST"]},"request_headers":{"description":"[dynamic_list, multiselect_dynamic_list] Custom request headers","type":"array","items":{"$ref":"#/components/schemas/Header"}},"custom_user_attributes":{"description":"[dynamic_list] Include custom user attributes in request","type":"boolean"},"other_values":{"description":"[dynamic_list, multiselect_list, multiselect_dynamic_list] Allow values outside predefined list","type":"boolean"},"delimiter":{"description":"[multiselect_list, multiselect_dynamic_list] Delimiter for multiple values","type":"string"}},"type":"object"}},"type":"object"},"ListItem":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"},"dependents":{"type":"array","items":{"$ref":"#/components/schemas/ListItemChild"}}},"type":"object"},"ListItemChild":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"},"dependents":{"type":"array","items":{"$ref":"#/components/schemas/ListItemDependent"}}},"type":"object"},"ListItemDependent":{"properties":{"value":{"type":"string"},"display_label":{"type":"string"}},"type":"object"},"Steps":{"properties":{"file_upload":{"properties":{"types":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"help":{"type":"string"},"sample_file_url":{"type":"string"},"size_mb":{"type":"integer"},"validation_msg":{"type":"string"},"copy_paste":{"type":"boolean"},"copy_delimiter":{"type":"string"},"show_upload":{"type":"boolean"},"worksheet_select":{"type":"boolean"},"description_option":{"type":"boolean"},"lang":{"type":"string"},"excel_date_format":{"type":"string"},"excel_date_custom":{"type":"string"},"hide_cancel":{"type":"boolean"},"split":{"description":"Split large files into multiple imports","type":"boolean"},"split_rows":{"description":"Rows per import when splitting (min 1)","type":"integer"},"split_confirm":{"description":"User confirmation required after each import: no=0, yes=1, no_if_no_errors=2","type":"string","enum":["no","yes","no_if_no_errors"]},"extract_types":{"description":"Allowed document extraction types (mapped to .pdf/.doc/images)","type":"array","items":{"type":"string","enum":["pdf","docs","images"]}},"page_limit":{"description":"Max pages allowed for extraction (null = no limit)","type":"integer","nullable":true}},"type":"object"},"select_header":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"default_row":{"type":"string"},"encoding_option":{"type":"boolean"},"encoding":{"type":"string"},"row_column_switch":{"type":"boolean"}},"type":"object"},"map_columns":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"mapping_mode":{"type":"string"},"bulk_cols_dd":{"type":"boolean"},"accept_unmapped":{"type":"boolean"},"accept_unmapped_select":{"type":"boolean"},"allow_zero_template":{"type":"boolean"},"ignore_cols":{"type":"boolean"},"ignore_cols_default":{"type":"boolean"},"user_keywords":{"type":"boolean"}},"type":"object"},"verify_data":{"properties":{"skip":{"type":"boolean"},"help":{"type":"string"},"row_display_mode":{"type":"string"},"export_option":{"type":"boolean"},"search_option":{"type":"boolean"},"ai_transform":{"type":"boolean"},"allow_new_rows":{"type":"boolean"},"rows_display":{"type":"integer"},"allow_invalid":{"type":"boolean"},"invalid_confirmation":{"type":"boolean"},"max_rows":{"type":"integer"},"allow_upload_if_max":{"type":"boolean"},"max_rows_msg":{"type":"string"},"min_rows":{"type":"integer"},"min_rows_msg":{"type":"string"}},"type":"object"},"results":{"properties":{"close_mode":{"type":"string"},"redirect_url":{"type":"string"},"success_type":{"type":"string"},"success_text":{"type":"string"},"success_method":{"type":"string"},"success_url":{"type":"string"},"failed_type":{"type":"string"},"failed_text":{"type":"string"},"failed_method":{"type":"string"},"failed_url":{"type":"string"},"show_resubmit":{"type":"boolean"},"show_error_text":{"type":"boolean"}},"type":"object"}},"type":"object"},"SecuritySettings":{"properties":{"region":{"type":"string","enum":["us","eu"]},"domains":{"type":"array","items":{"type":"string"}},"import_url_upload":{"type":"boolean"},"s3_upload":{"type":"boolean"}},"type":"object"},"SheetSuccessResponse":{"properties":{"status":{"type":"string"},"data":{"properties":{"sheet_license_key":{"type":"string"},"title":{"type":"string"}},"type":"object"}},"type":"object"},"ErrorResponse":{"properties":{"status":{"type":"string"},"errors":{"type":"object"}},"type":"object"}}},"paths":{"/1.1/sheet/{sheet_license_key}":{"patch":{"tags":["Sheets"],"summary":"Partially Update Sheet","description":"Partially updates an existing sheet. Only provided fields will be updated. Fields not included will remain unchanged.","operationId":"patchSheet","parameters":[{"name":"sheet_license_key","in":"path","description":"Sheet License Key","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/AcceptHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchSheetRequest"}}}},"responses":{"200":{"description":"Sheet Partially Updated Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SheetSuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Sheet Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```