address:delete

Status: 📅 Planned - Coming Soon

Description

This mutation message will delete a single address by its ID. Addresses can be associated with people, households, or organizations.

Expected Functionality

When implemented, this mutation will:

Delete an address by ID
Remove the address from any associated records (person, household, organization)
Return a message_id for async processing
Support bulk deletion in future versions

Expected Request Schema

{
  "payload": {
    "type": "address:delete",
    "id": 123
  },
  "signature": "payload_ed25519_hex_signature",
  "source_public_key": "your_client_public_key"
}

Request Attributes

payload.id - Integer - The address ID to delete

Expected Response Schema

{
  "source_public_key": "community_public_key",
  "source_site": {
    "protocol": "https",
    "fqdn": "arkipel.example.com"
  },
  "created_at": "2025-11-13T20:52:49Z",
  "signature": "...",
  "payload": {
    "type": "address:delete",
    "message_id": "abc123def456"
  }
}

Async Processing

This is an asynchronous mutation. Use arkipel_messages:query with the returned message_id to check deletion status.

Timeline

Expected implementation: Q2 2025

Get Notified

Want to know when this feature launches? Contact us at devkit@arkipel.co

people:upsert - Create/update people with nested addresses
households:upsert - Create/update households with addresses
organizations:upsert - Create/update organizations with addresses
person:delete - Delete a person (deletes associated addresses)
household:delete - Delete a household
organization:delete - Delete an organization

Important Notes

No undo: Deleted addresses cannot be recovered
Cascading effects: Other records referencing this address will have it removed
Main address protection: Cannot delete the only/main address without replacing it first

Use Cases

Data Cleanup: Remove outdated or incorrect addresses
Privacy Compliance: Delete addresses as part of data deletion requests
Merge Operations: Remove duplicate addresses after merging records

Return to API Specifications