Bulk operations API
12 REST endpoints for bulk operations, each with its parameters, the response it returns and a runnable curl example. Starts with GET /api/bulk/export.csv.
GET/api/bulk/export.csvThe Bulk Edit layout as a CSV, for editing offline.
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
domainId | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/bulk/importRun the import
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 4
| Name | In | Description |
|---|---|---|
domainId | body | JSON request field |
text | body | JSON request field |
rows | body | JSON request field |
mapping | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/bulk/jobsGet bulk jobs
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
GET/api/bulk/jobs/{id}/errors.csvGet bulk jobs by ID errors.csv
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
id | path | Required path parameter |
Examples in 22 languages and Try it →
Responses
GET/api/bulk/migration/bitlyBitly migration
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →
Responses
POST/api/bulk/migration/bitlyCreate or update bulk migration bitly
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 3
| Name | In | Description |
|---|---|---|
sourceDomain | body | JSON request field |
domainId | body | JSON request field |
enabled | body | JSON request field |
Examples in 22 languages and Try it →
Responses
POST/api/bulk/previewPreview an uploaded file (column mapping UI)
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
text | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/bulk/sheetBulk sheets — in-app grid (v2) load & apply
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domainId | query | Optional query parameter |
mode | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
POST/api/bulk/sheet/applyCreate or update bulk sheet apply
Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.
Parameters 2
| Name | In | Description |
|---|---|---|
domainId | body | JSON request field |
rows | body | JSON request field |
Examples in 22 languages and Try it →
Responses
GET/api/bulk/sheet/googleGoogle-Sheets-backed modes (v1) — returns the sheet contract
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
mode | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/bulk/template.csvGet bulk template.csv
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Parameters 1
| Name | In | Description |
|---|---|---|
kind | query | Optional query parameter |
Examples in 22 languages and Try it →
Responses
GET/api/bulk/templatesTemplates & column metadata
Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.
Examples in 22 languages and Try it →