Update Record Professional

Updates information for the specified professional associated with the specified record.

Resource Information

Scope	records Deprecated scope name: update_record_professional
App Type	All
Authorization Type	Access token
URI	/v4/records/{recordId}/professionals/{id}?lang={lang}
HTTP Method	PUT
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
id	string	Yes	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
addressLine1	string	No	�	The first line of the address.	7.3.2
addressLine2	string	No	�	The second line of the address.	7.3.2
addressLine3	string	No	�	The third line of the address.	7.3.2
birthDate	dateTime	No	�	The birth date of an individual.	7.3.2
businessLicense	string	No	�	The official business license number issued by an agency. A licensed professional can have the same license number assigned to multiple license types.	7.3.2
businessName	string	No	�	A secondary business name for the applicable individual.	7.3.2
businessName2	string	No	�	A secondary business name for the applicable individual.	7.3.2
city	string	No	�	The name of the city.	7.3.2
comment	string	No	�	Comments or notes about the current context.	7.3.2
country	country{}	No	Get All Address Countries	The name of the country.	7.3.2
country.text	string	No	�	The localized display text.	7.3.2
country.value	string	No	�	The value for the specified parameter.	7.3.2
email	string	No	�	The contact's email address.	7.3.2
expirationDate	dateTime	No	�	The date when the condition expires.	7.3.2
fax	string	No	�	The fax number for the contact.	7.3.2
federalEmployerId	string	No	�	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.2
firstName	string	No	�	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
fullName	string	No	�	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.2
gender	gender{}	No	�	The gender (male or female) of the individual.	7.3.2
gender.text	string	No	�	The localized display text.	7.3.2
gender.value	string	No	�	The value for the specified parameter.	7.3.2
id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
isPrimary	string	No	Y \| N	Indicates whether or not to designate the professional as the primary professional.	7.3.2
lastName	string	No	�	The last name (surname).	7.3.2
lastRenewalDate	dateTime	No	�	The last date for a professionals renewal license.	7.3.2
licenseNumber	string	No	�	This is the license number for the contact.	7.3.2
licenseType	licenseType{}	No	Get All Professional License Types	The type of license held by the professional.	7.3.2
licenseType.text	string	No	�	The localized display text.	7.3.2
licenseType.value	string	No	�	The value for the specified parameter.	7.3.2
licensingBoard	licensingBoard{}	No	Get All Professional License Boards	The name of the licensing board that issued the license.	7.3.2
licensingBoard.text	string	No	�	The localized display text.	7.3.2
licensingBoard.value	string	No	�	The value for the specified parameter.	7.3.2
middleName	string	No	�	The middle name.	7.3.2
originalIssueDate	dateTime	No	�	The original issuance date of license.	7.3.2
phone1	string	No	�	The primary telephone number of the contact.	7.3.2
phone2	string	No	�	The secondary telephone number of the contact.	7.3.2
phone3	string	No	�	The tertiary telephone number for the contact.	7.3.2
postalCode	string	No	�	The postal ZIP code for the address.	7.3.2
postOfficeBox	string	No	�	The post office box number.	7.3.2
recordId	recordId{}	No	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2
recordId.customId	string	No	�	An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.	7.3.2
recordId.id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
recordId.serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
recordId.trackingId	long	No	�	The application tracking number (IVR tracking number).	7.3.2
recordId.value	string	No	�	The value for the specified parameter.	7.3.2
referenceLicenseId	string	No	�	The unique Id generated for a professional stored in the system.	7.3.2
salutation	salutation{}	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.text	string	No	�	The localized display text.	7.3.2
salutation.value	string	No	�	The value for the specified parameter.	7.3.2
serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
state	state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.2
state.text	string	No	�	The localized display text.	7.3.2
state.value	string	No	�	The value for the specified parameter.	7.3.2
suffix	string	No	�	The contact name suffix.	7.3.2
title	string	No	�	The individual's business title.	7.3.2
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2

Response Information

Field	Type	Description	Automation Version
result	result{}	�	7.3.2
result.addressLine1	string	The first line of the address.	7.3.2
result.addressLine2	string	The second line of the address.	7.3.2
result.addressLine3	string	The third line of the address.	7.3.2
result.birthDate	dateTime	The birth date of an individual.	7.3.2
result.businessLicense	string	The official business license number issued by an agency. A licensed professional can have the same license number assigned to multiple license types.	7.3.2
result.businessName	string	A secondary business name for the applicable individual.	7.3.2
result.businessName2	string	A secondary business name for the applicable individual.	7.3.2
result.city	string	The name of the city.	7.3.2
result.comment	string	Comments or notes about the current context.	7.3.2
result.country	result.country{}	The name of the country.	7.3.2
result.country.text	string	The localized display text.	7.3.2
result.country.value	string	The value for the specified parameter.	7.3.2
result.email	string	The contact's email address.	7.3.2
result.expirationDate	dateTime	The date when the condition expires.	7.3.2
result.fax	string	The fax number for the contact.	7.3.2
result.federalEmployerId	string	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.2
result.firstName	string	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.fullName	string	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.2
result.gender	result.gender{}	The gender (male or female) of the individual.	7.3.2
result.gender.text	string	The localized display text.	7.3.2
result.gender.value	string	The value for the specified parameter.	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isPrimary	string	Indicates whether or not to designate the professional as the primary professional.	7.3.2
result.lastName	string	The last name (surname).	7.3.2
result.lastRenewalDate	dateTime	The last date for a professionals renewal license.	7.3.2
result.licenseNumber	string	This is the license number for the contact.	7.3.2
result.licenseType	result.licenseType{}	The type of license held by the professional.	7.3.2
result.licenseType.text	string	The localized display text.	7.3.2
result.licenseType.value	string	The value for the specified parameter.	7.3.2
result.licensingBoard	result.licensingBoard{}	The name of the licensing board that issued the license.	7.3.2
result.licensingBoard.text	string	The localized display text.	7.3.2
result.licensingBoard.value	string	The value for the specified parameter.	7.3.2
result.middleName	string	The middle name.	7.3.2
result.originalIssueDate	dateTime	The original issuance date of license.	7.3.2
result.phone1	string	The primary telephone number of the contact.	7.3.2
result.phone2	string	The secondary telephone number of the contact.	7.3.2
result.phone3	string	The tertiary telephone number for the contact.	7.3.2
result.postalCode	string	The postal ZIP code for the address.	7.3.2
result.postOfficeBox	string	The post office box number.	7.3.2
result.recordId	result.recordId{}	The unique ID associated with a record.	7.3.2
result.recordId.customId	string	An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.	7.3.2
result.recordId.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.recordId.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.recordId.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.recordId.value	string	The value for the specified parameter.	7.3.2
result.referenceLicenseId	string	The unique Id generated for a professional stored in the system.	7.3.2
result.salutation	result.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.text	string	The localized display text.	7.3.2
result.salutation.value	string	The value for the specified parameter.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.state	result.state{}	The state corresponding to the address on record.	7.3.2
result.state.text	string	The localized display text.	7.3.2
result.state.value	string	The value for the specified parameter.	7.3.2
result.suffix	string	The contact name suffix.	7.3.2
result.title	string	The individual's business title.	7.3.2
status	integer	The record status.	7.3.3