mailboxes

Update a mailbox

patch/v1/mailboxes/{id}

Request

  • Base URL: https://api.replylayer.ai
  • URL: https://api.replylayer.ai/v1/mailboxes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

agent_authoring_mode'send_and_draft' | 'draft_only' | 'read_only'
agent_send_containmentboolean
agent_send_policy'restricted' | 'open'
allow_thread_repliesboolean
apply_policy_mode'read_only' | 'draft_only' | 'supervised' | 'trusted'
approval_expiry'24h' | '72h' | '7d' | 'never'
confirm_open_human_sendsboolean
default_subaddress_mode'reply_to' | 'from' | 'none'
display_namestring nullable
force_emptyboolean
hitl_mode'disabled' | 'all_outbound' | 'risky_only'
pii_mode'passthrough' | 'redacted'
pii_redaction_configobject nullable
reauth_challengestring
reauth_tokenstring
recipient_policy_mode'blocklist' | 'allowlist'

Response

Success

addressstring required
agent_authoring_mode'send_and_draft' | 'draft_only' | 'read_only' required
agent_send_containmentboolean required
agent_send_policy'restricted' | 'open' required
allow_thread_repliesboolean required
attachment_access_accepted_atstring date-time nullable required
attachment_access_accepted_versionstring nullable required
attachment_access_enabledboolean required
attachment_allowed_file_familiesstring[] required
attachment_exposure_mode'metadata_only' | 'derived_content' | 'raw_download_selected_types' required
attachment_image_access_accepted_atstring date-time nullable required
attachment_image_access_accepted_versionstring nullable required
attachment_policy_versionstring nullable required
attachment_reauth_atstring date-time nullable required
current_disclaimer_versionstring required
current_image_risk_versionstring required
default_subaddress_mode'reply_to' | 'from' | 'none' required
display_namestring nullable required
effective_from_displaystring required
hitl_mode'disabled' | 'all_outbound' | 'risky_only' required
idstring required
image_raw_download_confirmedboolean required
last_applied_policy_modestring nullable required
legacy_wildcard_activeboolean required
namestring required
pii_mode'passthrough' | 'redacted' required
pii_redaction_configobject nullable required
recipient_policy_mode'blocklist' | 'allowlist' required
restricted_by'mailbox_allowlist' | 'agent_containment' | 'null' nullable required
scanner_policyobject nullable
send_windowobject nullable required
sender_policy_mode'blocklist' | 'allowlist' required

Changes

No recorded changes to this operation across all 1 revision of this API.