Create Record Professionals

Creates a new professional and associates the professional with the specified record.

Resource Information

Scoperecords

Deprecated scope name:   create_record_professionals

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/professionals?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo Indicates the language applied.7.3.2
addressLine1stringNo The first line of the address. 7.3.2
addressLine2stringNo The second line of the address.7.3.2
addressLine3stringNo The third line of the address.7.3.2
birthDatedateTimeNo The birth date of an individual.7.3.2
businessLicensestringNo 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
businessNamestringNo A secondary business name for the applicable individual.7.3.2
businessName2stringNo A secondary business name for the applicable individual.7.3.2
citystringNo The name of the city.7.3.2
commentstringNo Comments or notes about the current context.7.3.2
countrycountry{}No Get All Address Countries The name of the country.7.3.2
country.textstringNo The localized display text.7.3.2
country.valuestringNo The value for the specified parameter.7.3.2
emailstringNo The contact's email address.7.3.2
expirationDatedateTimeNo The date when the condition expires.7.3.2
faxstringNo The fax number for the contact.7.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
isPrimarystringNoY | NIndicates whether or not to designate the professional as the primary professional.7.3.2
lastNamestringNo The last name (surname). 7.3.2
lastRenewalDatedateTimeNo The last date for a professionals renewal license.7.3.2
licenseNumberstringNo This is the license number for the contact.7.3.2
licenseTypelicenseType{}No Get All Professional License Types The type of license held by the professional.7.3.2
licenseType.textstringNo The localized display text.7.3.2
licenseType.valuestringNo The value for the specified parameter.7.3.2
licensingBoardlicensingBoard{}No Get All Professional License Boards The name of the licensing board that issued the license. 7.3.2
licensingBoard.textstringNo The localized display text.7.3.2
licensingBoard.valuestringNo The value for the specified parameter.7.3.2
middleNamestringNo The middle name. 7.3.2
originalIssueDatedateTimeNo The original issuance date of license.7.3.2
phone1stringNo The primary telephone number of the contact. 7.3.2
phone2stringNo The secondary telephone number of the contact.7.3.2
phone3stringNo The tertiary telephone number for the contact.7.3.2
postalCodestringNo The postal ZIP code for the address.7.3.2
postOfficeBoxstringNo The post office box number.7.3.2
recordIdrecordId{}No Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
recordId.customIdstringNo 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.idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNo The application tracking number (IVR tracking number).7.3.2
recordId.valuestringNo The value for the specified parameter.7.3.2
referenceLicenseIdstringNo The unique Id generated for a professional stored in the system.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
statestate{}No Get All Address States The state corresponding to the address on record.7.3.2
state.textstringNo The localized display text.7.3.2
state.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
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Response Information

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