POST api/enlistedfeature/save

Save Enlisted Feature Configuration. Processes this enlisted feature API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The save enlisted feature configuration command data contract supplied with the request.

SaveEnlistedFeatureConfigurationCommandDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

FeatureId

The unique identifier of the related feature resource.

integer

None.

AppliesToRoles

The collection of applies to roles.

Collection of string

None.

ExternalProviderIds

The unique identifiers of the related external provider resources.

Collection of integer

None.

Steps

The collection of steps.

Collection of SaveEnlistedFeatureConfigurationStepCommandDataContract

None.

Id

The unique identifier of this resource.

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "FeatureId": 2,
  "AppliesToRoles": [
    "sample string 1",
    "sample string 2"
  ],
  "ExternalProviderIds": [
    1,
    2
  ],
  "Steps": [
    {
      "Name": "sample string 1",
      "ValidRoleStatuses": [
        "sample string 1",
        "sample string 2"
      ],
      "RequiredSteps": [
        {
          "EnlistedFeatureConfigurationStepId": 1,
          "Name": "sample string 2",
          "ValidStatuses": [
            "sample string 1",
            "sample string 2"
          ],
          "Id": 3
        },
        {
          "EnlistedFeatureConfigurationStepId": 1,
          "Name": "sample string 2",
          "ValidStatuses": [
            "sample string 1",
            "sample string 2"
          ],
          "Id": 3
        }
      ],
      "IsFinalStep": true,
      "Id": 3
    },
    {
      "Name": "sample string 1",
      "ValidRoleStatuses": [
        "sample string 1",
        "sample string 2"
      ],
      "RequiredSteps": [
        {
          "EnlistedFeatureConfigurationStepId": 1,
          "Name": "sample string 2",
          "ValidStatuses": [
            "sample string 1",
            "sample string 2"
          ],
          "Id": 3
        },
        {
          "EnlistedFeatureConfigurationStepId": 1,
          "Name": "sample string 2",
          "ValidStatuses": [
            "sample string 1",
            "sample string 2"
          ],
          "Id": 3
        }
      ],
      "IsFinalStep": true,
      "Id": 3
    }
  ],
  "Id": 3
}

Response Information

Resource Description

The response returned after the operation completes.

EnlistedFeatureConfigurationDataContract
NameDescriptionTypeAdditional information
Name

The name value.

string

None.

FeatureId

The unique identifier of the related feature resource.

integer

None.

AppliesToRoles

The collection of applies to roles.

Collection of EnumDataContract

None.

ExternalProviders

The collection of external providers.

Collection of RoleDataContract

None.

Steps

The collection of steps.

Collection of EnlistedFeatureConfigurationStepDataContract

None.

SystemStatus

The system status value.

EnumDataContract

None.

Id

The unique identifier of this resource.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "FeatureId": 2,
  "AppliesToRoles": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "ExternalProviders": [
    {
      "OwningTeamId": 1,
      "BranchId": 2,
      "Name": "sample string 3",
      "TeamAccessType": "sample string 4",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "CustomFields": [
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        },
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        }
      ],
      "CreatedDate": "2026-07-23T10:33:59.1440121Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 6
    },
    {
      "OwningTeamId": 1,
      "BranchId": 2,
      "Name": "sample string 3",
      "TeamAccessType": "sample string 4",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "CustomFields": [
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        },
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        }
      ],
      "CreatedDate": "2026-07-23T10:33:59.1440121Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 6
    }
  ],
  "Steps": [
    {
      "Name": "sample string 1",
      "ValidRoleStatuses": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "RequiredSteps": [
        {
          "FeatureStepConfiguration": {
            "Name": "sample string 1",
            "Id": 2
          },
          "ValidStatuses": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "Id": 1
        },
        {
          "FeatureStepConfiguration": {
            "Name": "sample string 1",
            "Id": 2
          },
          "ValidStatuses": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "Id": 1
        }
      ],
      "IsFinalStep": true,
      "Id": 3
    },
    {
      "Name": "sample string 1",
      "ValidRoleStatuses": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        }
      ],
      "RequiredSteps": [
        {
          "FeatureStepConfiguration": {
            "Name": "sample string 1",
            "Id": 2
          },
          "ValidStatuses": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "Id": 1
        },
        {
          "FeatureStepConfiguration": {
            "Name": "sample string 1",
            "Id": 2
          },
          "ValidStatuses": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "Id": 1
        }
      ],
      "IsFinalStep": true,
      "Id": 3
    }
  ],
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Id": 3
}