Delete Address Book Entries
starshipit_delete_addressesPermanently delete one or more address book entries by ID to remove outdated or duplicate addresses; verify IDs first because deletion cannot be undone.
Instructions
Delete one or more addresses from the StarShipIt address book by their IDs. This action is permanent and cannot be undone.
When to use: Call this to remove outdated, duplicate, or unwanted address entries. You can delete multiple addresses in a single call by passing an array of IDs.
CAUTION: Deletion is irreversible. Verify the IDs with starshipit_list_addresses before calling this tool.
Parameters:
address_ids— non-empty array of integer address book IDs to delete
Returns: A success confirmation. If any ID does not exist, the API may still return success for the IDs that were found.
Errors:
400 — empty array or invalid ID format
401/403 — authentication failure
Example — delete two addresses:
{ "address_ids": [81692357, 81692358] }Workflow tip: Always call starshipit_list_addresses with a search_term first to confirm which IDs you want to delete before proceeding.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address_ids | Yes | Array of address book IDs to permanently delete |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation or processing errors returned by StarShipIt | |
| object | No | The response payload when StarShipIt returns a non-object value | |
| success | No | StarShipIt success flag (a boolean on most endpoints) |