Skip to content

Unsubscribe Group ​

omnichannel.unsubscribe_group

Fields ​

Every record also has id, created_at and updated_at.

FieldLabelTypeRules
namenametextrequired; max 160 characters
from_emailfrom emailtextrequired; max 190 characters
provider_group_idprovider group idnumber
descriptiondescriptiontextmax 300 characters

Unique together: from_email

Permissions ​

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

API ​

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

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

Edulab Bench developer documentation