v1

latestOpenAPI 3.0.02026-07-2451442464.5 KB
Recipient

PUT /recipients/{domain}/{local_part}{property_field}

put/recipients/{domain}/{local_part}{property_field}

Path parameters

domainstring required
local_partstring required
property_field'no_auto_esr' | 'delivery_tls_outgoing' | 'blackholed' | 'enable_malware_access' | 'premium' | 'premium_available' | 'enable_filtering' | 'shared_mailbox' | 'should_archive' | 'date_format' | 'time_format' | 'filtering_available' | 'quarantine_disabled' | 'distribution_list' | 'relay' | 'submission_tls_outgoing' | 'ldap_username' | 'archiving_available' | 'delivery_tls_incoming' | 'quarantine_password_hash' | 'local_part' | 'timezone' | 'submission_tls_incoming' | 'exclude_from_sync' | 'enable_submission_filtering' | 'enable_oauth2' | 'domain' required

Request body

archiving_availablestring
date_formatstring
distribution_listboolean
domainstring
enable_filteringboolean
enable_malware_accessboolean
enable_oauth2boolean
enable_submission_filteringboolean
exclude_from_syncboolean
filtering_availablestring
ldap_usernamestring
local_partstring
no_auto_esrboolean
premiumboolean
premium_availablestring
shared_mailboxboolean
should_archiveinteger
time_formatstring
timezonestring

Response

Success

messagestring
num_resultsinteger
statusinteger