Skip to main content
POST
Update mapping schema

Restrictions

Usage

  • Fields left out keep their current values; team_id 0 removes the team.
  • An unknown schema_id returns InvalidParameter; a new schema_name must not be used by another schema.
  • Only an account admin, the schema creator, or a member of the schema’s owning team may call this; others get AccessDenied.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

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

Schema ID (MongoDB ObjectID hex).

schema_name
string | null

New name, unique among non-deleted schemas (max 39 characters). Omit to keep.

Maximum string length: 39
description
string | null

New description (max 500 characters). Omit to keep, send "" to clear.

Maximum string length: 500
team_id
integer<int64> | null

New owning team ID from POST /team/list; 0 removes the team. Omit to keep.

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.