Skip to main content

Delete Address Book

DELETE 
/v1/users/{userId}/contacts

Permanently deletes all synced contacts for this user.

When to Use​

  • Account Deletion: Remove all user data as part of account teardown
  • Privacy Request: User requests removal of contact data
  • Permission Revoked: User withdraws contact access permission

This action cannot be undone. After deletion, contact-based personalization features will be disabled until contacts are re-synced.

Path Parameters​

    userId stringrequired

    UUID for the given user

Header Parameters​

    x-hiya-product-version string

    Product version. The standard "major.minor.patch" format is highly encouraged without any leading characters; "2.1.3" or "3.0.0" for example.

    x-hiya-account-user-id stringrequired

    The identifier of a logged-in user. Same identifier that is used for /users/{user_id}

Responses​

Delete successful