Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APILegal & trust

Suppression routes

Every Suppression Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for Suppression.

NounSystemRun by
SuppressionMailboxesCustomer Lead

Suppression.create

Creates a Suppression. Verb page.

Text
POST /{namespace}/suppressions

Body, as JSON: the inputs. Emits Suppression.created.

Inputs

InputTypeRequiredDescription
addressstringrequiredThe email address or phone number.
reasonstringWhy it is suppressed, such as an opt-out or a bounce.
companyCompanyA Company’s Suppressions bind every Startup it holds: no commercial Message goes to a suppressed address.

Returns

OutputTypeRequiredDescription
suppressionSuppressionrequiredThe Suppression.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/suppressions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"Example address"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "suppression": {
    "$id": "https://api.sb/leaseline.app/suppressions/suppression_Ssbq90xC9R",
    "$type": "Suppression",
    "address": "Example address"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Suppression.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Suppression.get

Returns one Suppression by id. Verb page.

Text
GET /{namespace}/suppressions/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Suppression.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
suppressionSuppressionrequiredThe Suppression.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/suppressions/suppression_Ssbq90xC9R \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Suppression",
  "$id": "https://api.sb/leaseline.app/suppressions/suppression_Ssbq90xC9R",
  "suppression": {
    "$id": "https://api.sb/leaseline.app/suppressions/suppression_Ssbq90xC9R",
    "$type": "Suppression",
    "address": "Example address"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/suppressions/suppression_Ssbq90xC9R",
    "up": "https://api.sb/leaseline.app/suppressions"
  }
}

Suppression.list

Returns Suppressions, newest first, one page at a time. Verb page.

Text
GET /{namespace}/suppressions

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
suppressionslist of SuppressionrequiredOne page of Suppressions.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/suppressions?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Suppression",
  "suppressions": [
    {
      "$id": "https://api.sb/leaseline.app/suppressions/suppression_Ssbq90xC9R",
      "$type": "Suppression",
      "address": "Example address"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "suppression_Ssbq90xC9R"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/suppressions?limit=20",
    "next": "https://api.sb/leaseline.app/suppressions?after=suppression_Ssbq90xC9R"
  }
}

Screening

Previous

Core grammar

Next