POST residentapi/board/users

Add a user to a board committee

Request Information

URI Parameters

None.

Body Parameters

UserCommitteBoardCreate
NameDescriptionTypeAdditional information
PropertyId

CWS Property Id.

integer

Required

UserId

Cws User Id.

integer

Required

StartDate

StartDate. Board Member start date

date

Required

ExpirationDate

ExpirationDate. Board Member expiration date

date

Required

Request Formats

application/json, text/json

Sample:
{
  "propertyId": 1,
  "userId": 1,
  "startDate": "2025-12-24T09:11:14.6472463-05:00",
  "expirationDate": "2025-12-24T09:11:14.6472463-05:00"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserCommittee
NameDescriptionTypeAdditional information
UserCommitteeId

UserCommitteeId (Primary key)

integer

None.

CommitteeId

CommitteeId (Foreign Key to Property.Committee)

integer

None.

UserId

UserId (Foregin Key to Users)

integer

None.

StartDate

StartDate

date

None.

ExpirationDate

ExpirationDate

date

None.

User

User

CwsUser

None.

PropertyCommittee

PropertyCommittees Object

PropertyCommittee

None.

Response Formats

application/json, text/json

Sample:
{
  "userCommitteeId": 1,
  "committeeId": 2,
  "userId": 3,
  "startDate": "2025-12-24T09:11:14.6472463-05:00",
  "expirationDate": "2025-12-24T09:11:14.6472463-05:00",
  "user": {
    "userId": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "acceptedTermsAndConditions": true,
    "myUnits": [
      {
        "myUnitId": 1,
        "propertyId": 2,
        "userId": 3,
        "roleId": 4,
        "role": {
          "roleId": 1,
          "roleName": "sample string 2",
          "roleDescription": "sample string 3"
        },
        "marketId": 5,
        "connectPropertyId": 6,
        "connectUnitId": 7,
        "connectResidentId": 8,
        "isLinked": true,
        "isDeleted": true,
        "isActive": true,
        "propertyName": "sample string 12",
        "subDomain": "sample string 13",
        "propertyDisplayName": "sample string 14",
        "addresses": [
          {
            "addressId": 1,
            "myUnitId": 2,
            "addressTypeId": 3,
            "unitNumber": "sample string 4",
            "address1": "sample string 5",
            "address2": "sample string 6",
            "city": "sample string 7",
            "state": "sample string 8",
            "zip": "sample string 9",
            "country": "sample string 10",
            "type": {
              "typeId": 1,
              "name": "sample string 2",
              "description": "sample string 3"
            }
          },
          {
            "addressId": 1,
            "myUnitId": 2,
            "addressTypeId": 3,
            "unitNumber": "sample string 4",
            "address1": "sample string 5",
            "address2": "sample string 6",
            "city": "sample string 7",
            "state": "sample string 8",
            "zip": "sample string 9",
            "country": "sample string 10",
            "type": {
              "typeId": 1,
              "name": "sample string 2",
              "description": "sample string 3"
            }
          }
        ]
      },
      {
        "myUnitId": 1,
        "propertyId": 2,
        "userId": 3,
        "roleId": 4,
        "role": {
          "roleId": 1,
          "roleName": "sample string 2",
          "roleDescription": "sample string 3"
        },
        "marketId": 5,
        "connectPropertyId": 6,
        "connectUnitId": 7,
        "connectResidentId": 8,
        "isLinked": true,
        "isDeleted": true,
        "isActive": true,
        "propertyName": "sample string 12",
        "subDomain": "sample string 13",
        "propertyDisplayName": "sample string 14",
        "addresses": [
          {
            "addressId": 1,
            "myUnitId": 2,
            "addressTypeId": 3,
            "unitNumber": "sample string 4",
            "address1": "sample string 5",
            "address2": "sample string 6",
            "city": "sample string 7",
            "state": "sample string 8",
            "zip": "sample string 9",
            "country": "sample string 10",
            "type": {
              "typeId": 1,
              "name": "sample string 2",
              "description": "sample string 3"
            }
          },
          {
            "addressId": 1,
            "myUnitId": 2,
            "addressTypeId": 3,
            "unitNumber": "sample string 4",
            "address1": "sample string 5",
            "address2": "sample string 6",
            "city": "sample string 7",
            "state": "sample string 8",
            "zip": "sample string 9",
            "country": "sample string 10",
            "type": {
              "typeId": 1,
              "name": "sample string 2",
              "description": "sample string 3"
            }
          }
        ]
      }
    ],
    "photos": [
      {
        "photoId": 1,
        "userId": 2,
        "fileUrl": "sample string 3",
        "isDefault": true
      },
      {
        "photoId": 1,
        "userId": 2,
        "fileUrl": "sample string 3",
        "isDefault": true
      }
    ],
    "userPhones": [
      {
        "phoneId": 1,
        "userId": 2,
        "phoneTypeId": 3,
        "phoneNumber": "sample string 4",
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "countryCode": "sample string 5",
        "isVerified": true
      },
      {
        "phoneId": 1,
        "userId": 2,
        "phoneTypeId": 3,
        "phoneNumber": "sample string 4",
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "countryCode": "sample string 5",
        "isVerified": true
      }
    ],
    "userEmails": [
      {
        "emailId": 1,
        "userId": 2,
        "emailTypeId": 3,
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "email": "sample string 4",
        "isVerified": true
      },
      {
        "emailId": 1,
        "userId": 2,
        "emailTypeId": 3,
        "type": {
          "typeId": 1,
          "name": "sample string 2",
          "description": "sample string 3"
        },
        "email": "sample string 4",
        "isVerified": true
      }
    ],
    "committees": []
  },
  "propertyCommittee": {
    "property": {
      "propertyId": 1,
      "marketId": 2,
      "connectPropertyId": 3,
      "propertyName": "sample string 4"
    },
    "committeeID": 1,
    "propertyID": 2,
    "connectCommitteeID": 1,
    "name": "sample string 3",
    "description": "sample string 4",
    "isActive": true,
    "isDeleted": true,
    "isBoard": true
  }
}