Update Citizen Accounts

Updates the status of citizen accounts associated to the specified citizen user.

Resource Information

Scopeusers

Deprecated scope name:   update_citizenaccess_citizens_accounts

App TypeAll
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/{id}/accounts?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4
userModel[]userModel{}Yes7.3.3.4
userModel.activestringNoYes | NoIndicates whether or not the account is active. If the account is not activated, the user cannot login Accela Citizen Access.7.3.3.4
userModel.servProvCodestringNo The agency name.7.3.3.4
userModel.statusstringNoEnable | DisableThe citizen userid status.7.3.3.4
userModel.userIdlongNo The citizen userid.7.3.3.4

Example

Sample Request Head

PUT https://apis.accela.com/v4/citizenaccess/citizens/8661/accounts

Sample Request Body

[
  {
    "servProvCode": "BPTDEV",
    "userId": 8661,
    "status": "Enable",
    "Active": "Yes"
  }
]

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3.4
result.codestringA code identifying an associated item7.3.3.4
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.3.4
result.messagestringA text message related to the operation.7.3.3.4
statusintegerThe record status.7.3.3.4

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": 8661,
      "isSuccess": true
    }
  ]
}