Skip to content

by Startups.Studio

Contact.subscribe

POST /{namespace}/contacts/{contact}/subscribe

Subscribe records a Contact’s chosen topics and frequency from the hosted preference page, with Consent for each topic.

Noun: Contact
Mode: do
Event: Contact.subscribed

You, to your agent

Subscribe the contact Tomas Berg.

curl -X POST https://api.sb/kilnbakery.com/contacts/contact_1/subscribe \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"topics":["Example topics"]}'

import { $ } from 'startup-builder'

const contact = await $.Contact.subscribe({ contact: 'contact_1', topics: ['Example topics'] })

npx startup-builder do Contact.subscribe --json '{"contact":"contact_1","topics":["Example topics"]}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Contact.subscribe({ contact: 'contact_1', topics: ['Example topics'] })"
  }
}

Inputs

Input	Type	Required	Description
`contact`	Contact	required	The Contact.
`topics`	`string[]`	required	The topics the Contact chose.

Outputs

Output	Type	Required	Description
`contact`	Contact	required	The Contact, with their topics.

Effects

Emits Contact.subscribed.
Performed by the Marketing Lead.
Two-way: it runs at once, in the try, send and do modes.
Writes one Consent per topic, with its notice and time.

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

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

Previous Page

Contact.suppress

Next Page