Ad routes: update, delete · StartupBuilder

Reference for Ad, one group of Ad routes.

Ad.update

Changes the given properties of an Ad. Verb page.

Text

PATCH /{namespace}/ads/{id}

Path: id. Body, as JSON: the other inputs. Emits Ad.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Ad.
`format`	`string`		One of `search`, `display`, `image`, or `video`.
`spend`	`money`		What it has cost so far.

Returns

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

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

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "ad": {
    "$id": "https://api.sb/leaseline.app/ads/ad_yVW4IAmeOW",
    "$type": "Ad",
    "format": "search"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Ad.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Ad.delete

Deletes an Ad: a soft delete that keeps its history, undone by Thing.restore. Verb page.