Home > Aria Crescendo Documentation > Aria Crescendo core api > update_contact_m

update_contact_m

Updates contact information for Aria accounts or Billing Groups.

For a list of error messages generated by this API, see update_contact_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
required-icon.png contact_ind long 1

Contact Indicator that indicates contact input type.

Valid inputs are 1-5 and are as follows:
1 Account Contact, 2 Primary Payment Method’s Contact of the given Billing Group, 3 Backup or Secondary Billing Contact of the given Billing Group, 4 Statement Contact of the given Billing Group, 5 Account contact only

NOTES: When selecting Option 1, the service destination contact is also updated. Also for Option 1, other objects linked to this account contact will also be mapped to the updated contact. For Option 5, other objects linked to this account contact will be retained with the old contact. Specifically, "other objects" above refers to "payment method, billing group statement, and service destination". 

Allowable values for contact_ind

Values Description
1 Account Contact - Other objects linked to this account contact will also be mapped to the updated contact. Here, "other objects" refers specifically to payment method, billing group statement, and service destination.
2 Primary Billing Contact - Primary payment method’s contact of a given billing group.
3 Secondary Billing Contact  - Refers to backup payment method’s contact of a given billing group.
4 Statement Contact - Statement contact of a given billing group.
5 Account Contact Only - Other objects linked to this account contact will be retained with the old contact. Here, "other objects" refers specifically to payment method, billing group statement, and service destination.
  billing_group_no long 22 Billing Group Number
  OR      
  client_billing_group_id string 100 Client-defined Master Billing Group ID.
  first_name string 300 Contact First Name
  middle_initial string 2 Middle Initial of the Contact.
  last_name string 300 Contact Last Name
  company_name string 100 Company name of the contact
  address1 string 300 First address line of the contact.
  address2 string 300 Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
  address3 string 300 The third line of the address
  city string 300 City of the contact
  locality string 32

Locality of the contact. Use this field instead of the <state_prov> field to identify the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada.

This field is ignored for all addresses in the United States, Australia, and Canada.
  state_prov string 10 State or province of the contact.

The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.

This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries.
  country_cd string 25 Country of the contact. The ISO-compliant 2-character country code abbreviation in upper case.
  postal_cd string 15 Postal/Zip code for the contact address.
  phone string 25 The phone number of the contact
  phone_ext string 10 The extension for the contact phone
  cell_phone string 20 The contact cell phone.
  work_phone string 25 Work phone number of the contact.
  work_phone_ext string 10 The extension for the contact work phone
  fax string 25 The FAX phone number for the contact.
  email string 320 Email of the contact
  birthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
contact_no long The Aria-assigned unique identifier for the contact created on this account. DEPRECATED
contact_no_2 long The Aria-assigned unique identifier for the contact created on this account.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®