Skip to content

by Startups.Studio

Growth Audience

Audience.create

POST /{namespace}/audiences

Creates an Audience.

Noun: Audience
Mode: do
Event: Audience.created

You, to your agent

Add an audience to QuietCopy with a noun.

curl -X POST https://api.sb/quietcopy.com/audiences \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"audience_1","type":["noun_1"]}'

import { $ } from 'startup-builder'

const audience = await $.Audience.create({ id: 'audience_1', type: ['noun_1'] })

npx startup-builder do Audience.create --json '{"id":"audience_1","type":["noun_1"]}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Audience.create({ id: 'audience_1', type: ['noun_1'] })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The stable identifier, which never changes.
`type`	list of Noun	required	The Nouns this Thing is an instance of.
`outside`	`json`		The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
`query`	`json`		The saved query that defines a dynamic Collection.
`size`	`integer`		How many people match.

Outputs

Output	Type	Required	Description
`audience`	Audience	required	The Audience.

Effects

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

Audience

Previous Page

Audience.delete

Next Page