Survey methods: update, delete
The Survey Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Survey, one group of Survey methods.
Survey.update
Changes the given properties of a Survey. Verb page.
interface SurveyVerbs {
update(input: SurveyUpdateInput, options?: SB.CallOptions): SB.Call<Survey>
}Emits Survey.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Survey. |
fields | json | The fields and their types. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
survey | Survey | required | The Survey. |
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
import { $ } from 'startup-builder'
const survey = await $.Survey.update({ id: 'survey_NLUCLYDcII', fields: {} })Survey.delete
Deletes a Survey: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface SurveyVerbs {
delete(input: SurveyDeleteInput, options?: SB.CallOptions): SB.Call<Survey>
}Emits Survey.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Survey. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
survey | Survey | required | The Survey. |
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
import { $ } from 'startup-builder'
const survey = await $.Survey.delete({ id: 'survey_NLUCLYDcII' })