GEgetinboxzero

POST /senders/unsubscribe

Changed on

Unsubscribe from a sender for the scoped inbox. Looks up List-Unsubscribe from that sender's mail when a link is not provided. Check unsubscribe.success: when it is false the sender was left unchanged.

Request

  • Base URL
    https://www.getinboxzero.com/api/v1
  • URL
    https://www.getinboxzero.com/api/v1/senders/unsubscribe
  • Auth
    API key in header API-Key

Request body

senderEmailstring email required
unsubscribeLinkstring uri
listUnsubscribeHeaderstring

Response

Unsubscribe attempt completed

senderEmailstring email required
status'UNSUBSCRIBED' | 'null' nullable required

Changes