Audience methods: update, delete

Reference for Audience, one group of Audience methods.

Audience.update

Changes the given properties of an Audience. Verb page.

TypeScript

interface AudienceVerbs {
  update(input: AudienceUpdateInput, options?: SB.CallOptions): SB.Call<Audience>
}

Emits Audience.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Audience.
`type`	list of Noun		The Nouns this Thing is an instance of.
`outside`	`json`		The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
`query`	`json`		The saved query that defines a dynamic Collection.
`size`	`integer`		How many people match.

Returns

Output	Type	Required	Description
`audience`	Audience	required	The Audience.

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

TypeScript

import { $ } from 'startup-builder'

const audience = await $.Audience.update({ id: 'audience_vmVkEYrXCN', size: 1 })

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

TypeScript

interface AudienceVerbs {
  delete(input: AudienceDeleteInput, options?: SB.CallOptions): SB.Call<Audience>
}

Emits Audience.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Audience.

Returns

Output	Type	Required	Description
`audience`	Audience	required	The Audience.

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

TypeScript

import { $ } from 'startup-builder'

const audience = await $.Audience.delete({ id: 'audience_vmVkEYrXCN' })