Skip to main content
POST
Upload mapping data via CSV

Restrictions

Usage

  • Send multipart/form-data with the CSV in the file field; schema_id and do_not_truncate_first are query parameters. The file may be at most 100 MB.
  • The first CSV row is the header and must contain every source and result label; other columns are dropped. Values longer than 2,048 bytes are rejected, and byte-order marks are stripped. A file with no data rows returns InvalidParameter.
  • By default all existing rows are deleted before the import. With do_not_truncate_first=TRUE existing rows are kept and rows with the same source label values are replaced.
  • Rows with the same source label values are merged; the later row wins.
  • The schema row limit (10,000 rows by default, higher for some accounts) is checked against the row count after the import; exceeding it returns InvalidParameter.
  • Rows are written in batches of 100. If a batch fails, the truncation and the batches before it stay applied.
  • The schema must exist and not be deleted; otherwise InvalidParameter.
  • Only an account admin, the schema creator, or a member of the schema’s owning team may call this; others get AccessDenied.
  • Data writes to one schema (upsert, delete, truncate, CSV upload) run one at a time; a call made while another is running returns RequestTooFrequently.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Query Parameters

schema_id
string
required

ID of the target mapping schema (ObjectID hex).

Pattern: ^[0-9a-fA-F]{24}$
do_not_truncate_first
string

Pass TRUE (case-insensitive) to append instead of replacing. When omitted and the schema already has data, the server truncates existing rows before importing.

Body

multipart/form-data
file
file
required

CSV file, max 100 MB. The header row must include all of the schema's source/result label names.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.