Sign in
Contact Rules

Create Contact Rule

post/api/v1/mail/mailboxes/{email_address}/contact-rules

Path parameters

email_addressstring required

Request body

action'allow' | 'block' required
match_type'exact_email' | 'domain' required
match_targetstring required

What the rule matches against. For EXACT_EMAIL: a full email address (stored lowercased). For DOMAIN: a bare domain like 'gmail.com'.

Response

Successful Response

idstring uuid required
mailbox_idstring uuid required
action'allow' | 'block' required
match_type'exact_email' | 'domain' required
match_targetstring required
status'active' | 'paused' | 'deleted' required
created_atstring date-time required
updated_atstring date-time required

Changes

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