Skip to main content
POST
Create 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"

Body

application/json
title
string
required
Example:

"Customer Import"

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

POST: every item listed is created. Omitting the key creates nothing.

Maximum array length: 20
validation_functions
object[]

POST: every item listed is created. Omitting the key creates nothing. 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[]

POST: every item listed is created. Omitting the key creates nothing.

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 Created Successfully

status
string
Example:

"Sheet Created Successfully"

data
object