Update Citizen Profile

Updates the profile of the specified citizen user.

Resource Information

Scopeusers

Deprecated scope name:   update_citizenaccess_citizens

App TypeAll
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/{id}?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
emailstringNo The citizen user's email address.7.3.3.4
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
loginNamestringNo The citizen user's login name.7.3.3.4
mobilePhonestringNo The citizen user's 10-digit cell phone number.7.3.3.4
mobilePhoneCountryCodestringNo The country code for the cell phone number.7.3.3.4
questions[]questions{}No The security question for password reset. 7.3.3.4
receiveSMSstringNoY | NIndicates whether or not the user prefers to receive SMS messages.7.3.3.4
registerDatedateTimeNo The citizen user's registration date.7.3.3.4
rolestringNoCONTRACT_INSPECTOR | CITIZEN | AUTH_AGENT_CLERK | AUTH_AGENT | SELF_CERTIFIED_INSPECTORThe citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR.7.3.3.4

Example

Sample Request Head

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

Sample Request Body

{
  "cellPhone": "925-551-8131",
  "receiveSMS": "Y"
}

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3.4
result.emailstringThe citizen user's email address.7.3.3.4
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.loginNamestringThe citizen user's login name.7.3.3.4
result.mobilePhonestringThe citizen user's 10-digit cell phone number.7.3.3.4
result.mobilePhoneCountryCodestringThe country code for the cell phone number.7.3.3.4
result.questions[]result.questions{}The security question for password reset. 7.3.3.4
result.receiveSMSstringIndicates whether or not the user prefers to receive SMS messages.7.3.3.4
result.registerDatedateTimeThe citizen user's registration date.7.3.3.4
result.rolestringThe citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR.7.3.3.4
statusintegerThe record status.7.3.3.4