INinkbox
Contact Rules

Update Contact Rule

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

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/{rule_id}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

rule_idstring uuid required
email_addressstring required

Request body

action'allow' | 'block'
direction'inbound' | 'outbound' | 'both'
apply_to'inbound' | 'outbound' nullable

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 new optional request property

    • info

      added the optional property to the response with the status