AddressBookService

Delete Address Book Entry

Delete one address-book entry from the selected address book. Session tokens only; callers with enrolled MFA need recent assurance.

Method

DELETE

Path

/v1/auth/address-book-entries/{address_book_entry_id}

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Conditionally required

DELETE

/v1/auth/address-book-entries/{address_book_entry_id}

Request

Testnet

curl --request DELETE \ \
  --url 'https://api.testnet.polyester.com/v1/auth/address-book-entries/1' \
  --header 'Accept: */*' \
  --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
  --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
  --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'

Responses

{}

address_book_entry_id string (int64) required > 0

Address-book entry id to delete.

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.