Skip to content

by Startups.Studio

Legal & trust Suppression

Suppression.create

POST /{namespace}/suppressions

Creates a Suppression.

Noun: Suppression
Mode: do
Event: Suppression.created

You, to your agent

Add a suppression to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/suppressions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"Example address"}'

import { $ } from 'startup-builder'

const suppression = await $.Suppression.create({ address: 'Example address' })

npx startup-builder do Suppression.create --json '{"address":"Example address"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Suppression.create({ address: 'Example address' })"
  }
}

Create makes a new Suppression from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	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.
`company`	Company		A Company’s Suppressions bind every Startup it holds: no commercial Message goes to a suppressed address.

Outputs

Output	Type	Required	Description
`suppression`	Suppression	required	The Suppression.

Effects

Emits Suppression.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Suppression.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Suppression

Previous Page

Suppression.get

Next Page