Deactivate a field mapping version.

POST

/api/admin/field-mapping/field-mapping-sets/{fieldMappingSetId}/versions/{fieldMappingVersionId}/deactivate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets/example/versions/example/deactivate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Deactivates an active field mapping version and returns a lifecycle transition result envelope.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

fieldMappingSetId

required

string

Field mapping set identifier.

fieldMappingVersionId

required

string

Field mapping version identifier.

Header Parameters

Idempotency-Key

string

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

Request Body

Media type application/json

object

key

additional properties

Example

{}

Responses

200

Lifecycle transition response.

Media type application/json

object

result

required

object

id

required

string

tenantId

string

fieldMappingSetId

string

fieldMappingVersionId

string

lifecycleState

required

string

reviewedAt

integer

activatedAt

integer

publishedAt

integer

deactivatedAt

integer

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "fieldMappingSetId": "example",
    "fieldMappingVersionId": "example",
    "lifecycleState": "example",
    "reviewedAt": 1,
    "activatedAt": 1,
    "publishedAt": 1,
    "deactivatedAt": 1
  }
}

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"
}