Create Record Owners

Creates a new owner association for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   create_record_owners

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNoIndicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
emailstringNoThe contact's email address.7.3.2
faxstringNoThe fax number for the contact.7.3.2
firstNamestringNoThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
fullNamestringNoThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
idlongNoThe 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 owner as the primary owner.7.3.2
lastNamestringNoThe last name (surname). 7.3.2
mailAddressmailAddress{}NoContains the fields that define an owner's address.7.3.2
mailAddress.addressLine1stringNoThe first line of the address. 7.3.2
mailAddress.addressLine2stringNoThe second line of the address.7.3.2
mailAddress.addressLine3stringNoThe third line of the address.7.3.2
mailAddress.citystringNoThe name of the city.7.3.2
mailAddress.countrymailAddress.country{}No Get All Address Countries The name of the country.7.3.2
mailAddress.country.textstringNoThe localized display text.7.3.2
mailAddress.country.valuestringNoThe value for the specified parameter.7.3.2
mailAddress.postalCodestringNoThe postal ZIP code for the address.7.3.2
mailAddress.statemailAddress.state{}No Get All Address States The state corresponding to the address on record.7.3.2
mailAddress.state.textstringNoThe localized display text.7.3.2
mailAddress.state.valuestringNoThe value for the specified parameter.7.3.2
middleNamestringNoThe middle name. 7.3.2
phonestringNoThe telephone number of the user. 7.3.2
recordIdrecordId{}No Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2
recordId.customIdstringNoAn 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.idstringNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
recordId.serviceProviderCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
recordId.trackingIdlongNoThe application tracking number (IVR tracking number).7.3.2
recordId.valuestringNoThe value for the specified parameter.7.3.2
refOwnerIddoubleNoThe unique Id generated for an owner stored in the system.7.3.2
statusstatus{}NoThe owner status.7.3.2
status.textstringNoThe localized display text.7.3.2
status.valuestringNoThe value for the specified parameter.7.3.2
taxIdstringNoThe owner's tax ID number.7.3.2
titlestringNoThe individual's business title. 7.3.2
typestringNoThe owner type.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