Skip to content

by Startups.Studio

Growth Campaign

Campaign.create

POST /{namespace}/campaigns

Creates a Campaign.

Noun: Campaign
Mode: do
Event: Campaign.created

You, to your agent

Add a campaign to QuietCopy.

curl -X POST https://api.sb/quietcopy.com/campaigns \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"budget":{"amount":39,"currency":"USD"}}'

import { $ } from 'startup-builder'

const campaign = await $.Campaign.create({ budget: { amount: 39, currency: 'USD' } })

npx startup-builder do Campaign.create --json '{"budget":{"amount":39,"currency":"USD"}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Campaign.create({ budget: { amount: 39, currency: 'USD' } })"
  }
}

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

Inputs

Input	Type	Required	Description
`budget`	`money`		What it may spend.
`startsAt`	`datetime`		When it starts.
`endsAt`	`datetime`		When it ends.
`goal`	Goal		A Campaign spends its budget and window toward one Goal.

Outputs

Output	Type	Required	Description
`campaign`	Campaign	required	The Campaign.

Effects

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

Campaign

Previous Page

Campaign.delete

Next Page