Skip to navigation
API referenceAdministrative Function Group

UpdateAddressBookItem

View as Markdown

Updates and inserts all the specified items passed to your address book. This method returns an UpdateAddressBookResult object.

Schema

UpdateAddressBookItems
NameSchema TypeDescription
AddressBookItemsAddressBookItem ArrayArray of address book items to update or insert.
ReturnAddressBookBooleanIf true, return the address book item list in the UpdateAddressBookResult object.

UpdateAddressBookResult

UpdateAddressBookResult
NameSchema TypeDescription
SuccessBooleanTrue if successful.
AddressBookItemsAddressBookItem ArrayArray of AddressBookItem after the updates are completed. The AddressBookItem object is described in the GetAddressBookItems section.

Rules and exceptions for UpdateAddressBookItems

  • Account_Lacks_Permissions – account does not have permissions to use this API.
  • User_Lacks_Permissions – user does not have permissions to use this API.
  • Address book items that are passed to this API that the user does not own will not be removed.
  • If the address book ID is left blank in the AddressBookItem object a new address book entry will be added.
  • If the AddressBookItem share is changed and the user does not have address book sharing privileges, the address book item share will not be updated.
  • AddressBook_Email_Invalid – if there is an invalid email in the address book items passed to the API this error will be returned and no updates will be done.