Update Contact

Updates information for a specified contact.

Resource Information

Scopecontacts

Deprecated scope name:   update_contact

App TypeAgency
Authorization TypeAccess token
URI /v4/contacts/{id}?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.2

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.2
langStringNo Indicates the language applied.7.3.2
addressaddress{}No The citizen user's address.7.3.2
address.addressLine1stringNo The first line of the address. 7.3.2
address.addressLine2stringNo The second line of the address.7.3.2
address.addressLine3stringNo The third line of the address.7.3.2
address.citystringNo The name of the city.7.3.2
address.countryaddress.country{}No Get All Address Countries The name of the country.7.3.2
address.country.textstringNo The localized display text.7.3.2
address.country.valuestringNo The value for the specified parameter.7.3.2
address.postalCodestringNo The postal ZIP code for the address.7.3.2
address.stateaddress.state{}No Get All Address States The state corresponding to the address on record.7.3.2
address.state.textstringNo The localized display text.7.3.2
address.state.valuestringNo The value for the specified parameter.7.3.2
birthCitybirthCity{}No The city of birth for an individual.7.3.2
birthCity.textstringNo The localized display text.7.3.2
birthCity.valuestringNo The value for the specified parameter.7.3.2
birthDatedateTimeNo The birth date of an individual.7.3.2
birthRegionbirthRegion{}No The country of birth or region of birth for an individual.7.3.2
birthRegion.textstringNo The localized display text.7.3.2
birthRegion.valuestringNo The value for the specified parameter.7.3.2
birthStatebirthState{}No Get All Address States The state of birth for an individual.7.3.2
birthState.textstringNo The localized display text.7.3.2
birthState.valuestringNo The value for the specified parameter.7.3.2
businessNamestringNo A secondary business name for the applicable individual.7.3.2
commentstringNo Comments or notes about the current context.7.3.2
deceasedDatedateTimeNo The date of death. This field is active only when the Contact Type selected is Individual.7.3.2
driverLicenseNumberstringNo The driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.2
driverLicenseStatedriverLicenseState{}No Get All Address States The state that issued the driver's license.7.3.2
driverLicenseState.textstringNo The localized display text.7.3.2
driverLicenseState.valuestringNo The value for the specified parameter.7.3.2
emailstringNo The contact's email address.7.3.2
faxstringNo The fax number for the contact.7.3.2
faxCountryCodestringNo Fax Number Country Code7.3.2
federalEmployerIdstringNo The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
firstNamestringNo The contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
fullNamestringNo The contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
gendergender{}No The gender (male or female) of the individual.7.3.2
gender.textstringNo The localized display text.7.3.2
gender.valuestringNo The value for the specified parameter.7.3.2
idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
individualOrOrganizationstringNo The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
lastNamestringNo The last name (surname). 7.3.2
middleNamestringNo The middle name. 7.3.2
organizationNamestringNo The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
passportNumberstringNo The contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.2
phone1stringNo The primary telephone number of the contact. 7.3.2
phone1CountryCodestringNo Phone Number 1 Country Code7.3.2
phone2stringNo The secondary telephone number of the contact.7.3.2
phone2CountryCodestringNo Phone Number 2 Country Code7.3.2
phone3stringNo The tertiary telephone number for the contact.7.3.2
phone3CountryCodestringNo Phone Number 3 Country Code7.3.2
postOfficeBoxstringNo The post office box number.7.3.2
preferredChannelpreferredChannel{}No Get All Contact Preferred Channels The method by which the contact prefers to be notified, by phone for example.7.3.2
preferredChannel.textstringNo The localized display text.7.3.2
preferredChannel.valuestringNo The value for the specified parameter.7.3.2
racerace{}No Get All Contact Races The contact's race/ethnicity.7.3.2
race.textstringNo The localized display text.7.3.2
race.valuestringNo The value for the specified parameter.7.3.2
relationrelation{}No The contact's relationship to the application or service request.7.3.2
relation.textstringNo The localized display text.7.3.2
relation.valuestringNo The value for the specified parameter.7.3.2
salutationsalutation{}No Get All Contact Salutations The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.7.3.2
salutation.textstringNo The localized display text.7.3.2
salutation.valuestringNo The value for the specified parameter.7.3.2
serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
socialSecurityNumberstringNo The individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.2
stateIdNumberstringNo The contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.2
statusstatus{}No The contact status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
suffixstringNo The contact name suffix.7.3.2
titlestringNo The individual's business title. 7.3.2
tradeNamestringNo The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.2
typetype{}No Get All Contact Types The type of people to contact. 7.3.2
type.textstringNo The localized display text.7.3.2
type.valuestringNo The value for the specified parameter.7.3.2

Example

Sample Request Body

{"email":"apitester@accela.com","individualOrOrganization":"individual","phone1":"9256593200","firstName":"API","lastName":"Tester","type":{"value":"Individual","text":"Individual"},"preferredChannel":{"value":"1","text":"Email"},"status":{"value":"A","te

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.addressresult.address{}The citizen user's address.7.3.2
result.address.addressLine1stringThe first line of the address. 7.3.2
result.address.addressLine2stringThe second line of the address.7.3.2
result.address.addressLine3stringThe third line of the address.7.3.2
result.address.citystringThe name of the city.7.3.2
result.address.countryresult.address.country{}The name of the country.7.3.2
result.address.country.textstringThe localized display text.7.3.2
result.address.country.valuestringThe value for the specified parameter.7.3.2
result.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.address.stateresult.address.state{}The state corresponding to the address on record.7.3.2
result.address.state.textstringThe localized display text.7.3.2
result.address.state.valuestringThe value for the specified parameter.7.3.2
result.birthCityresult.birthCity{}The city of birth for an individual.7.3.2
result.birthCity.textstringThe localized display text.7.3.2
result.birthCity.valuestringThe value for the specified parameter.7.3.2
result.birthDatedateTimeThe birth date of an individual.7.3.2
result.birthRegionresult.birthRegion{}The country of birth or region of birth for an individual.7.3.2
result.birthRegion.textstringThe localized display text.7.3.2
result.birthRegion.valuestringThe value for the specified parameter.7.3.2
result.birthStateresult.birthState{}The state of birth for an individual.7.3.2
result.birthState.textstringThe localized display text.7.3.2
result.birthState.valuestringThe value for the specified parameter.7.3.2
result.businessNamestringA secondary business name for the applicable individual.7.3.2
result.commentstringComments or notes about the current context.7.3.2
result.deceasedDatedateTimeThe date of death. This field is active only when the Contact Type selected is Individual.7.3.2
result.driverLicenseNumberstringThe driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.2
result.driverLicenseStateresult.driverLicenseState{}The state that issued the driver's license.7.3.2
result.driverLicenseState.textstringThe localized display text.7.3.2
result.driverLicenseState.valuestringThe value for the specified parameter.7.3.2
result.emailstringThe contact's email address.7.3.2
result.faxstringThe fax number for the contact.7.3.2
result.faxCountryCodestringFax Number Country Code7.3.2
result.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.genderresult.gender{}The gender (male or female) of the individual.7.3.2
result.gender.textstringThe localized display text.7.3.2
result.gender.valuestringThe value for the specified parameter.7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.individualOrOrganizationstringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.lastNamestringThe last name (surname). 7.3.2
result.middleNamestringThe middle name. 7.3.2
result.organizationNamestringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.passportNumberstringThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.2
result.phone1stringThe primary telephone number of the contact. 7.3.2
result.phone1CountryCodestringPhone Number 1 Country Code7.3.2
result.phone2stringThe secondary telephone number of the contact.7.3.2
result.phone2CountryCodestringPhone Number 2 Country Code7.3.2
result.phone3stringThe tertiary telephone number for the contact.7.3.2
result.phone3CountryCodestringPhone Number 3 Country Code7.3.2
result.postOfficeBoxstringThe post office box number.7.3.2
result.preferredChannelresult.preferredChannel{}The method by which the contact prefers to be notified, by phone for example.7.3.2
result.preferredChannel.textstringThe localized display text.7.3.2
result.preferredChannel.valuestringThe value for the specified parameter.7.3.2
result.raceresult.race{}The contact's race/ethnicity.7.3.2
result.race.textstringThe localized display text.7.3.2
result.race.valuestringThe value for the specified parameter.7.3.2
result.relationresult.relation{}The contact's relationship to the application or service request.7.3.2
result.relation.textstringThe localized display text.7.3.2
result.relation.valuestringThe value for the specified parameter.7.3.2
result.salutationresult.salutation{}The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.7.3.2
result.salutation.textstringThe localized display text.7.3.2
result.salutation.valuestringThe value for the specified parameter.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.socialSecurityNumberstringThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.2
result.stateIdNumberstringThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.2
result.statusresult.status{}The contact status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.suffixstringThe contact name suffix.7.3.2
result.titlestringThe individual's business title. 7.3.2
result.tradeNamestringThe contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.2
result.typeresult.type{}The type of people to contact. 7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "result": {
    "serviceProviderCode": "ISLANDTON",
    "id": "253",
    "email": "apitester@accela.com",
    "individualOrOrganization": "individual",
    "phone1": "9256593200",
    "firstName": "API",
    "lastName": "Tester",
    "type": {
      "value": "Individual",
      "text": "Individual"
    },
    "preferredChannel": {
      "value": "1",
      "text": "Email"
    },
    "status": {
      "value": "A",
      "text": "Active"
    },
    "address": {
      "state": {
        "value": "CA",
        "text": "CA"
      }
    }
  },
  "status": 200
}