Skip to content

by Startups.Studio

Ad.create

POST /{namespace}/ads

Creates an Ad.

Noun: Ad
Mode: do
Event: Ad.created

You, to your agent

Add an ad to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/ads \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"search"}'

import { $ } from 'startup-builder'

const ad = await $.Ad.create({ format: 'search' })

npx startup-builder do Ad.create --json '{"format":"search"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Ad.create({ format: 'search' })"
  }
}

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

Inputs

Input	Type	Required	Description
`format`	`string`	required	One of `search`, `display`, `image`, or `video`.
`spend`	`money`		What it has cost so far.
`campaign`	Campaign		A Campaign places Ads that share its budget and window.
`offer`	Offer		Each Ad sells one Offer.

Outputs

Output	Type	Required	Description
`ad`	Ad	required	The Ad.

Effects

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

Ad

Previous Page

Ad.delete

Next Page