Unsubscribe from email sender

org.intentschema.communication.email.message.unsubscribe.v1

JSON: bare · @sha256:f66c461b003a…
Hash: sha256:f66c461b003aac8f6393a3ab79f19d5190756aa9b463aeef976b76ae121b7327

Send an RFC 8058 one-click unsubscribe to the sender (CAN-SPAM 10-day honor; GDPR Art. 21).

Payload

FieldTypeDescription
target *Target (required: external_id)
objectobject
idempotency_keystring
object

open object — no declared properties

Result

FieldTypeDescription
external_idstring
unsubscribed_atstring (date-time)

Examples

unsubscribe

{
  "target": {
    "system": "gmail",
    "external_id": "msg_abc123"
  }
}

Profiles