Skip to main content
POST
Truncate mapping data

Restrictions

Usage

  • Permanently deletes every data row of the schema; the schema itself is kept.
  • 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).

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.