Updates information about the specified owner for the specified record.
Scope | records Deprecated scope name: update_record_owner |
App Type | All |
Authorization Type | Access token |
URI | /v4/records/{recordId}/owners/{id}?lang={lang} |
HTTP Method | PUT |
Automation Version(s) | 7.3.2 |
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 |
recordId | string | Yes | Get All Records Search Records Get My Records | The unique ID associated with a record. | 7.3.2 |
string | No | � | The contact's email address. | 7.3.2 | |
fax | string | No | � | The fax number for the contact. | 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 |
id | long | 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 owner as the primary owner. | 7.3.2 |
lastName | string | No | � | The last name (surname). | 7.3.2 |
mailAddress | mailAddress{} | No | � | Contains the fields that define an owner's address. | 7.3.2 |
mailAddress.addressLine1 | string | No | � | The first line of the address. | 7.3.2 |
mailAddress.addressLine2 | string | No | � | The second line of the address. | 7.3.2 |
mailAddress.addressLine3 | string | No | � | The third line of the address. | 7.3.2 |
mailAddress.city | string | No | � | The name of the city. | 7.3.2 |
mailAddress.country | mailAddress.country{} | No | Get All Address Countries | The name of the country. | 7.3.2 |
mailAddress.country.text | string | No | � | The localized display text. | 7.3.2 |
mailAddress.country.value | string | No | � | The value for the specified parameter. | 7.3.2 |
mailAddress.postalCode | string | No | � | The postal ZIP code for the address. | 7.3.2 |
mailAddress.state | mailAddress.state{} | No | Get All Address States | The state corresponding to the address on record. | 7.3.2 |
mailAddress.state.text | string | No | � | The localized display text. | 7.3.2 |
mailAddress.state.value | string | No | � | The value for the specified parameter. | 7.3.2 |
middleName | string | No | � | The middle name. | 7.3.2 |
phone | string | No | � | The telephone number of the user. | 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 |
refOwnerId | double | No | � | The unique Id generated for an owner stored in the system. | 7.3.2 |
status | status{} | No | � | The owner status. | 7.3.2 |
status.text | string | No | � | The localized display text. | 7.3.2 |
status.value | string | No | � | The value for the specified parameter. | 7.3.2 |
taxId | string | No | � | The owner's tax ID number. | 7.3.2 |
title | string | No | � | The individual's business title. | 7.3.2 |
type | string | No | � | The owner type. | 7.3.2 |
Field | Type | Description | Automation Version |
---|---|---|---|
result | result{} | � | 7.3.2 |
result.email | string | The contact's email address. | 7.3.2 |
result.fax | string | The fax number for the contact. | 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.id | long | 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 owner as the primary owner. | 7.3.2 |
result.lastName | string | The last name (surname). | 7.3.2 |
result.mailAddress | result.mailAddress{} | Contains the fields that define an owner's address. | 7.3.2 |
result.mailAddress.addressLine1 | string | The first line of the address. | 7.3.2 |
result.mailAddress.addressLine2 | string | The second line of the address. | 7.3.2 |
result.mailAddress.addressLine3 | string | The third line of the address. | 7.3.2 |
result.mailAddress.city | string | The name of the city. | 7.3.2 |
result.mailAddress.country | result.mailAddress.country{} | The name of the country. | 7.3.2 |
result.mailAddress.country.text | string | The localized display text. | 7.3.2 |
result.mailAddress.country.value | string | The value for the specified parameter. | 7.3.2 |
result.mailAddress.postalCode | string | The postal ZIP code for the address. | 7.3.2 |
result.mailAddress.state | result.mailAddress.state{} | The state corresponding to the address on record. | 7.3.2 |
result.mailAddress.state.text | string | The localized display text. | 7.3.2 |
result.mailAddress.state.value | string | The value for the specified parameter. | 7.3.2 |
result.middleName | string | The middle name. | 7.3.2 |
result.phone | string | The telephone number of the user. | 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.refOwnerId | double | The unique Id generated for an owner stored in the system. | 7.3.2 |
result.status | result.status{} | The owner status. | 7.3.2 |
result.status.text | string | The localized display text. | 7.3.2 |
result.status.value | string | The value for the specified parameter. | 7.3.2 |
result.taxId | string | The owner's tax ID number. | 7.3.2 |
result.title | string | The individual's business title. | 7.3.2 |
result.type | string | The owner type. | 7.3.2 |
status | integer | The record status. | 7.3.3 |