POST api/CTRole/DeleteUserByRole/Organization/{orgKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orgKey

integer

Required

Body Parameters

DeleteUsersModel
NameDescriptionTypeAdditional information
OrgKey

integer

None.

RoleKey

integer

None.

Users

Collection of UserRoleModel

None.

Request Formats

application/json, text/json

Sample:
{
  "users": [
    {
      "role": {
        "orgKey": 1,
        "roleKey": 2,
        "roleName": "sample string 3",
        "roleShortName": "sample string 4",
        "roleDescription": "sample string 5",
        "transactions": [
          {
            "transactionKey": 1,
            "transactionName": "sample string 2",
            "transactionDescription": "sample string 3",
            "roleKey": 4,
            "statusKey": 64,
            "transactionType": {
              "transactionTypeKey": 1,
              "transactionTypeName": "sample string 2",
              "transactionTypeDescription": "sample string 3"
            }
          },
          {
            "transactionKey": 1,
            "transactionName": "sample string 2",
            "transactionDescription": "sample string 3",
            "roleKey": 4,
            "statusKey": 64,
            "transactionType": {
              "transactionTypeKey": 1,
              "transactionTypeName": "sample string 2",
              "transactionTypeDescription": "sample string 3"
            }
          }
        ]
      },
      "roleBranch": {
        "key": 1,
        "name": "sample string 2"
      },
      "siteTemplate": {
        "templateKey": 1,
        "templateHeadingColor": "sample string 2",
        "templateSidebarColor": "sample string 3",
        "templateTextColor": "sample string 4"
      },
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "addressCity": "sample string 3",
        "addressState": "sample string 4",
        "addressZipCode": "sample string 5"
      },
      "emails": [
        {
          "userKey": 1,
          "emailType": "sample string 1",
          "emailTypeKey": 64,
          "contactEmailAddress": "sample string 3",
          "contactEmailKey": 4,
          "contactKey": 5
        },
        {
          "userKey": 1,
          "emailType": "sample string 1",
          "emailTypeKey": 64,
          "contactEmailAddress": "sample string 3",
          "contactEmailKey": 4,
          "contactKey": 5
        }
      ],
      "userRoleKey": 1,
      "userKey": 2,
      "contactKey": 3,
      "contactFirstName": "sample string 4",
      "contactLastName": "sample string 5",
      "userRoleFromDate": "2026-01-29T20:38:43.4424456+00:00",
      "userRoleToDate": "2026-01-29T20:38:43.4424456+00:00",
      "roleKey": 6,
      "userStatusName": "sample string 7",
      "companyKey": 8,
      "orgKey": 9,
      "branchKey": 10,
      "branchCode": "sample string 11",
      "branchName": "sample string 12",
      "companyName": "sample string 13",
      "branchTimeZone": "sample string 14",
      "productlines": {
        "productlineKey": 1,
        "productlineName": "sample string 2",
        "productlineshortName": "sample string 3"
      },
      "productLinesArray": [
        {
          "productlineKey": 1,
          "productlineName": "sample string 2",
          "productlineshortName": "sample string 3"
        },
        {
          "productlineKey": 1,
          "productlineName": "sample string 2",
          "productlineshortName": "sample string 3"
        }
      ],
      "name": "sample string 15",
      "contactPhoneNumber": "sample string 16",
      "logoURI": "sample string 17",
      "logoFileName": "sample string 18",
      "alternateEmail": "sample string 19",
      "email": "sample string 20",
      "templateKey": 1
    },
    {
      "role": {
        "orgKey": 1,
        "roleKey": 2,
        "roleName": "sample string 3",
        "roleShortName": "sample string 4",
        "roleDescription": "sample string 5",
        "transactions": [
          {
            "transactionKey": 1,
            "transactionName": "sample string 2",
            "transactionDescription": "sample string 3",
            "roleKey": 4,
            "statusKey": 64,
            "transactionType": {
              "transactionTypeKey": 1,
              "transactionTypeName": "sample string 2",
              "transactionTypeDescription": "sample string 3"
            }
          },
          {
            "transactionKey": 1,
            "transactionName": "sample string 2",
            "transactionDescription": "sample string 3",
            "roleKey": 4,
            "statusKey": 64,
            "transactionType": {
              "transactionTypeKey": 1,
              "transactionTypeName": "sample string 2",
              "transactionTypeDescription": "sample string 3"
            }
          }
        ]
      },
      "roleBranch": {
        "key": 1,
        "name": "sample string 2"
      },
      "siteTemplate": {
        "templateKey": 1,
        "templateHeadingColor": "sample string 2",
        "templateSidebarColor": "sample string 3",
        "templateTextColor": "sample string 4"
      },
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "addressCity": "sample string 3",
        "addressState": "sample string 4",
        "addressZipCode": "sample string 5"
      },
      "emails": [
        {
          "userKey": 1,
          "emailType": "sample string 1",
          "emailTypeKey": 64,
          "contactEmailAddress": "sample string 3",
          "contactEmailKey": 4,
          "contactKey": 5
        },
        {
          "userKey": 1,
          "emailType": "sample string 1",
          "emailTypeKey": 64,
          "contactEmailAddress": "sample string 3",
          "contactEmailKey": 4,
          "contactKey": 5
        }
      ],
      "userRoleKey": 1,
      "userKey": 2,
      "contactKey": 3,
      "contactFirstName": "sample string 4",
      "contactLastName": "sample string 5",
      "userRoleFromDate": "2026-01-29T20:38:43.4424456+00:00",
      "userRoleToDate": "2026-01-29T20:38:43.4424456+00:00",
      "roleKey": 6,
      "userStatusName": "sample string 7",
      "companyKey": 8,
      "orgKey": 9,
      "branchKey": 10,
      "branchCode": "sample string 11",
      "branchName": "sample string 12",
      "companyName": "sample string 13",
      "branchTimeZone": "sample string 14",
      "productlines": {
        "productlineKey": 1,
        "productlineName": "sample string 2",
        "productlineshortName": "sample string 3"
      },
      "productLinesArray": [
        {
          "productlineKey": 1,
          "productlineName": "sample string 2",
          "productlineshortName": "sample string 3"
        },
        {
          "productlineKey": 1,
          "productlineName": "sample string 2",
          "productlineshortName": "sample string 3"
        }
      ],
      "name": "sample string 15",
      "contactPhoneNumber": "sample string 16",
      "logoURI": "sample string 17",
      "logoFileName": "sample string 18",
      "alternateEmail": "sample string 19",
      "email": "sample string 20",
      "templateKey": 1
    }
  ],
  "orgKey": 1,
  "roleKey": 2
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PageViewModel
NameDescriptionTypeAdditional information
StatusCode

integer

None.

StatusMessage

string

None.

TotalCount

integer

None.

ModelObject

Object

None.

CurrentDateTime

date

None.

Response Formats

application/json, text/json

Sample:
{
  "statusCode": 1,
  "statusMessage": "sample string 2",
  "totalCount": 3,
  "modelObject": {},
  "currentDateTime": "2026-01-29T20:38:43.4581228+00:00"
}