Delete a field mapping set.

DELETE

/api/admin/field-mapping/field-mapping-sets/{fieldMappingSetId}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets/example \
  --header 'Authorization: Bearer <token>'

Deletes a field mapping set by id and returns a mutation result envelope.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

fieldMappingSetId

required

string

Field mapping set identifier.

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Responses

200

Delete mutation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

string

deleted

required

boolean

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "deleted": true
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}