Contact commands: subscribe, suppress, unsubscribe
The Contact Verbs subscribe, suppress, unsubscribe as CLI commands, with inputs, result, refusals and an example.
Reference for Contact, one group of Contact commands.
Contact.subscribe
Subscribe records a Contact’s chosen topics and frequency from the hosted preference page, with Consent for each topic. Verb page.
npx startup-builder do Contact.subscribe --json '<input>' [--try | --send | --do]Emits Contact.subscribed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
contact | Contact | required | The Contact. |
topics | string[] | required | The topics the Contact chose. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
contact | Contact | required | The Contact, with their topics. |
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. | None. |
Example
npx startup-builder do Contact.subscribe --json '{"contact":Contact.suppress
Suppress records a Suppression for a Contact’s address, which every Startup honors forever. Verb page.
npx startup-builder do Contact.suppress --json '<input>' [--try | --send | --do]Emits Contact.suppressed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
contact | Contact | required | The Contact who opts out. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
contact | Contact | required | The suppressed Contact. |
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. | None. |
Example
npx startup-builder do Contact.suppress --json '{"contact":Contact.unsubscribe
Unsubscribe stops commercial Messages to a Contact in one click, for one topic or all, honored at once. Verb page.
npx startup-builder do Contact.unsubscribe --json '<input>' [--try | --send | --do]Emits Contact.unsubscribed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
contact | Contact | required | The Contact. |
topic | string | One topic; omitted, every commercial topic. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
contact | Contact | required | The Contact, unsubscribed. |
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. | None. |
Example
npx startup-builder do Contact.unsubscribe --json '{"contact":