INinkbox
Contact Rules

Create Contact Rule

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

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/mail/mailboxes/{email_address}/contact-rules
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

email_addressstring required

Request body

direction'inbound' | 'outbound' | 'both'
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
direction'inbound' | 'outbound' | 'both'
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

  • f3dcdb50fbaaRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status