Skip to main content

Sync Address Book

PUT 
/v1/users/{userId}/contacts

Uploads the user's complete address book for contact-based call screening enhancements.

Purpose​

Syncing contacts enables the AI Voice Platform to:

  • Identify Known Callers: Display contact names for incoming calls
  • Prioritize Trusted Callers: Contacts can receive expedited screening or auto-transfer
  • Personalized Greetings: AI assistant can reference the caller by name

When to Use​

  • Initial Setup: Call once after user grants contact access
  • Re-sync: Call if user restores from backup or changes devices

Data Handling​

Contact data is encrypted at rest and used solely for call screening personalization. Contacts are never shared with third parties.

For incremental updates after initial sync, use POST /contacts instead.

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}

Body

required

application/json

Responses​

OK

Response Body

application/json