Skip to main content
POST
Upsert mapping data rows

Restrictions

Usage

  • A row is identified by its source label values. A row whose values match an existing row replaces it entirely, and its created_at and updated_at are reset.
  • Each row must contain every source and result label (otherwise InvalidParameter); other keys are dropped. Values longer than 2,048 bytes are rejected.
  • Rows with the same source label values in one request are merged; the later row wins.
  • A schema holds at most 10,000 rows by default (higher for some accounts). A request that would grow the schema beyond the limit returns InvalidParameter; replacing existing rows is still allowed.
  • Rows are written in batches of 100; if a batch fails, the batches before it stay written.
  • 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.

Body

application/json
schema_id
string
required

Mapping schema ID (MongoDB ObjectID hex).

docs
object[]
required

Rows to insert or replace (at most 1,000). Each row maps label names to values and must include every source and result label; other keys are dropped; a value longer than 2,048 bytes is rejected. A row whose source label values match an existing row replaces it.

Maximum array length: 1000

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

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.