hornet icon

hornet

Interact with hornet API

Actions452

Archiving → Email Archiving User Settings Post

AI-generated

Summary

Update email archiving user settings for a specified customer object, configuring options such as marking emails as private and enabling manual archiving.

Inputs

  • Object Id (required) — The unique numeric identifier of the customer object whose email archiving settings will be updated.
  • APP ID (required) — The unique application identifier issued to your app, sent as a request header to authenticate the operation.
  • Mark As Private — Boolean flag to enable or disable users' ability to mark emails as private, protecting those emails from access during audits.
  • Archive Manually — Boolean flag to allow or disallow users to manually send emails to the archive, e.g., via an Outlook add-in.

Output shape

a single response object confirming the update or including updated settings

The operation sends a POST request including the specified boolean flags in the body and the object and app identifiers as query and header parameters respectively. The response reflects the result of the update. No pagination or additional metadata is indicated.

Links

Discussion