Suppression · StartupBuilder

Properties

Property	Type	Required	Description
`address`	`string`	required	The email address or phone number.
`reason`	`string`		Why it is suppressed, such as an opt-out or a bounce.

Object

JSON

{
  "$id": "https://api.sb/patentpad.com/suppressions/suppression_1",
  "$type": "Suppression",
  "address": "Example address",
  "reason": "Example reason"
}

Relationships

A Suppression is kept by one Company: a Company’s Suppressions bind every Startup it holds: no commercial Message goes to a suppressed address. keptBy, inverse keeps.

Verbs

createCreates a Suppression.
POST /{namespace}/suppressionsdoSuppression.created
getReturns one Suppression by id.
GET /{namespace}/suppressions/{id}readNo Event
listReturns Suppressions, newest first, one page at a time.
GET /{namespace}/suppressionsreadNo Event

A Suppression is kept forever and never edited: it has no update or delete.

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Suppression.create`	Yes	Yes	Yes	No
`Suppression.get`	Yes	Yes	Yes	Yes
`Suppression.list`	Yes	Yes	Yes	Yes

Call it

Text

Add a suppression to ShiftNote.

Example

A florist unsubscribes from one sibling's newsletter. The Suppression, kept by their Company, stops commercial Messages to her from every Startup it holds, with reason: unsubscribed.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link