Skip to content

by Startups.Studio

Contact.unsubscribe

POST /{namespace}/contacts/{contact}/unsubscribe

Unsubscribe stops commercial Messages to a Contact in one click, for one topic or all, honored at once.

Noun: Contact
Mode: do
Event: Contact.unsubscribed

You, to your agent

Unsubscribe the contact Rosa Ibarra.

curl -X POST https://api.sb/patentpad.com/contacts/contact_1/unsubscribe \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const contact = await $.Contact.unsubscribe({ contact: 'contact_1' })

npx startup-builder do Contact.unsubscribe --json '{"contact":"contact_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Contact.unsubscribe({ contact: 'contact_1' })"
  }
}

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The Contact.
`topic`	`string`		One topic; omitted, every commercial topic.

Outputs

Output	Type	Required	Description
`contact`	Contact	required	The Contact, unsubscribed.

Effects

Emits Contact.unsubscribed.
Performed by the Marketing Lead.
Two-way: it runs at once, in the try, send and do modes.
Writes a Suppression when no topic is named.
Never asks for sign-in or confirmation, and never waits.

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.	Contact.unsubscribe

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`.

Contact.suppress

Previous Page

Contact.update

Next Page