Skip to content

by Startups.Studio

Survey.create

POST /{namespace}/surveys

Creates a Survey.

Noun: Survey
Mode: do
Event: Survey.created

You, to your agent

Add a survey to TutorLoop.

curl -X POST https://api.sb/tutorloop.com/surveys \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fields":{}}'

import { $ } from 'startup-builder'

const survey = await $.Survey.create({ fields: {} })

npx startup-builder do Survey.create --json '{"fields":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Survey.create({ fields: {} })"
  }
}

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

Inputs

Input	Type	Required	Description
`fields`	`json`	required	The fields and their types.

Outputs

Output	Type	Required	Description
`survey`	Survey	required	The Survey.

Effects

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

Survey

Previous Page

Survey.delete

Next Page