Skip to main content
POST
Import Events

Description

Queues an events CSV import from a public HTTPS CSV URL. Build mapping in the dashboard Import wizard (Events), then copy the JSON from Review. Attribute keys must match what the dashboard shows for your workspace — do not invent them by hand. See Get mapping from the dashboard. Also see CSV Import Introduction for auth, limits, and statuses.

Headers

string
required
Your API key for authentication. Must have Dashboard permission.
string
required
Your workspace ID for authentication. Must own the API key.
string
default:"application/json"
required
Must be application/json.

Body

string
required
Public HTTPS URL of the CSV. Must return raw CSV bytes (not an HTML share/preview page).
array
required
Column → attribute map copied from the dashboard. Each item needs csv_column and attribute. CSV column names and attribute keys must be unique (case-insensitive).

Request Example

Use the mapping array exported from the dashboard Review step for your file — do not rely on the sample keys above.

Response

boolean
Indicates whether the API call was successful.
string
Success or error message from the API.
object
Queued import details.
string
Unique import job ID. Use this to poll status or cancel.
string
Initial job status. Typically in-queue.

Typical 400 messages

  • mapping is required / mapping entries require csv_column and attribute
  • unsupported mapping attribute for events: …