Skip to main content
PUT
Update Sheet

Authorizations

x-csvbox-api-key
string
header
required
x-csvbox-secret-api-key
string
header
required

Headers

Accept
string
required

Must be application/json

Example:

"application/json"

Content-Type
string
required

Content type must be application/json

Example:

"application/json"

Path Parameters

sheet_license_key
string
required

Sheet License Key

Body

application/json
title
string
Example:

"Updated Sheet"

webhooks
object[]
destinations
object[]
sheet_columns
object[]
Example:
steps
object
security_settings
object
virtual_columns
object[]

PUT is AUTHORITATIVE for a collection it sends: items listed are created or updated in place, and any existing item this array does not name is DELETED. Sending [] deletes every virtual column on the sheet. Omitting the key entirely leaves the collection untouched. Use _delete under PATCH instead if you want targeted removal.

Maximum array length: 20
validation_functions
object[]

PUT is AUTHORITATIVE: unlisted existing items are DELETED, [] empties the collection, an omitted key leaves it untouched. Two functions are shown: check_email needs nothing beyond the built-ins, while check_date declares dayjs — remove that dependency and its code is rejected with js_disallowed_global. That entry omits the optional integrity field so this body can be sent unmodified; in your own sheet add "integrity": "sha384-<digest published by the CDN>" beside the url, and add further scripts as further comma-separated objects in the same array (5 max).

Maximum array length: 10
Example:
data_transforms
object[]

PUT is AUTHORITATIVE: unlisted existing items are DELETED, [] empties the collection, an omitted key leaves it untouched.

Maximum array length: 10
pdf_metadata_config
object[]

Fields to extract from an uploaded PDF/DOCX. Sending the key replaces the whole stored array; omitting it leaves any existing configuration untouched.

Maximum array length: 20
Example:

Response

Sheet Updated Successfully

status
string
Example:

"Sheet Created Successfully"

data
object