For AI agents: visit https://email.opensrs.guide/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Guides

Overview

Introduction

Overview
Roles
Sending requests
Errors
Example clients
Data constraints

Authentication Methods

Overview
authenticate
echo
t2fa_setup

Company methods

Overview
change_company
change_company_bulletin
get_company
get_company_bulletin
get_company_changes
post_company_bulletin

Domain methods

Overview
change_domain
change_domain_bulletin
delete_domain
get_domain
get_domain_bulletin
get_domain_changes
post_domain_bulletin
restore_domain
search_domains
push_domain

Workgroup methods

Overview
create_workgroup
delete_workgroup
search_workgroups

User methods

search_admins
Overview
change_user
delete_user
generate_token
get_deleted_contacts
get_deleted_messages
get_user
get_user_attribute_history
get_user_changes
get_user_folders
get_user_messages
logout_user
move_user_messages
reindex
rename_user
restore_deleted_contacts
restore_deleted_messages
restore_user
search_users
add_role
set_role
user_notify
remove_role
user_disable_2fa
app_password
reset_email_test
get_sieve
set_sieve

Brand Methods

Overview
search_brands
_change_brand
_get_brand
_delete_brand
search_brand_members

Stats methods

Overview
stats_list
stats_snapshot
stats_summary

Migration methods

Overview
migration_add
migration_jobs
migration_status
migration_trace

Powered by

Overview

This section contains the following methods:

authenticate—Verifies a set of user credentials.
echo—Returns the JSON request.

Updated over 1 year ago

Data constraints