Skip to content

Suppression ​

omnichannel.suppression · every change is kept in the audit log

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
addressaddresstextrequired; personal data; max 190 characters
channelchannelselectone of: Email, WhatsApp, SMS, Slack, Voice; default "Email"
kindkindselectrequired; one of: Unsubscribe, Spam report, Bounce, Blocked
sourcesourceselectone of: Link, One-click, Webhook, Provider sync, Manual; default "Manual"
groupgrouplink → omnichannel.unsubscribe_group
campaigncampaignlink → omnichannel.campaign
reasonreasontextmax 300 characters
activeactivecheckdefault true
suppressed_atsuppressed atdatetime
resubscribed_atresubscribed atdatetime
resubscribed_byresubscribed bylink → core.user

Unique together: address + channel + kind + group

Permissions ​

RoleCan
omnichannel:adminread, create, update, delete, import, export
omnichannel:editorread, create
omnichannel:viewerread

API ​

http
GET    /api/omnichannel/suppression?<field>=<value>&limit=100&offset=0
POST   /api/omnichannel/suppression
GET    /api/omnichannel/suppression/:id
PATCH  /api/omnichannel/suppression/:id
DELETE /api/omnichannel/suppression/:id

Bulk import: GET /api/_import/omnichannel/suppression/template (CSV template), then POST /api/_import/omnichannel/suppression. See REST API.

Edulab Bench developer documentation