Skip to navigation

RemoveAddressBookItems

View as Markdown

Schema

RemoveAddressBookItems
// Grab all the address book items from the specified account
DocuSignWeb.AddressBookItem[] items = _apiClient.GetAddressBookItems(_accountId);
if(items.Length >= 1)
{
// Use the address book ID of an item to remove it
DocuSignWeb.AddressBookRemoveItem toRemove = new DocuSignWeb.AddressBookRemoveItem();
toRemove.AddressBookID = items[0].AddressBookID;
// Construct an array with all the items you want to remove
DocuSignWeb.AddressBookRemoveItem[] remove = { toRemove };
DocuSignWeb.UpdateAddressBookResult result = _apiClient.RemoveAddressBookItems(remove,
false);
// Confirm that the removal succeeded
Console.WriteLine("Removed item {0} succeeded? {1}", toRemove.AddressBookID,
result.Success);
}
NameSchema TypeDescription
AddressBookRemoveItemsAddressBookRemoveItem ArrayArray of address book item IDs to remove.
ReturnAddressBookBooleanIf true, return the address book item list in the UpdateAddressBookResult object.

Removes all the specified items passed from your address book. This method returns an UpdateAddressBookResult object described earlier.

AddressBookRemoveItem

Schema

AddressBookRemoveItem
NameSchema TypeDescription
AddressBookIDDSXIdAddress book ID to remove.

Rules and exceptions for RemoveAddressBookItems

  • 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.
  • Invalid address book IDs will be ignored.