Skip to Content

Addressbooks: create, read, update and delete them, their trash, their changes feed, import and export, sharing and feed tokens.

Its 18 methods, each a page of its own, in the order the API reference presents them:

MethodWhat it doesIt calls
addressbooks.createCreate addressbookPOST /identities/{identityId}/addressbooks
addressbooks.listList addressbooksGET /identities/{identityId}/addressbooks
addressbooks.getGet addressbook by IDGET /identities/{identityId}/addressbooks/{addressbookId}
addressbooks.getByNameGet addressbook by nameGET /identities/{identityId}/addressbooks/by-name/{name}
addressbooks.updateUpdate addressbookPATCH /identities/{identityId}/addressbooks/{addressbookId}
addressbooks.deleteDelete addressbookDELETE /identities/{identityId}/addressbooks/{addressbookId}
addressbooks.listTrashList deleted addressbooksGET /identities/{identityId}/addressbooks/trash
addressbooks.restoreRestore deleted addressbookPOST /identities/{identityId}/addressbooks/trash/{trashedAddressbookId}/restore
addressbooks.purgePurge deleted addressbookDELETE /identities/{identityId}/addressbooks/trash/{trashedAddressbookId}
addressbooks.getChangesSync changes for addressbookGET /identities/{identityId}/addressbooks/{addressbookId}/changes
addressbooks.importImport addressbook dataPOST /identities/{identityId}/addressbooks/{addressbookId}/import
addressbooks.exportExport whole addressbookGET /identities/{identityId}/addressbooks/{addressbookId}/export
addressbooks.grantAccessGrant addressbook accessPUT /identities/{identityId}/addressbooks/{addressbookId}/shares/{shareeIdentityId}
addressbooks.revokeAccessRevoke addressbook accessDELETE /identities/{identityId}/addressbooks/{addressbookId}/shares/{shareeIdentityId}
addressbooks.listAccessList addressbook access grantsGET /identities/{identityId}/addressbooks/{addressbookId}/shares
addressbooks.createFeedTokenCreate addressbook feed tokenPOST /identities/{identityId}/addressbooks/{addressbookId}/tokens
addressbooks.listFeedTokensList addressbook feed tokensGET /identities/{identityId}/addressbooks/{addressbookId}/tokens
addressbooks.revokeFeedTokenRevoke addressbook feed tokenDELETE /identities/{identityId}/addressbooks/{addressbookId}/tokens/{tokenId}

In the API reference: PIM.