Contact methods: update, delete

Reference for Contact, one group of Contact methods.

Contact.update

Changes the given properties of a Contact. Verb page.

TypeScript

interface ContactVerbs {
  update(input: ContactUpdateInput, options?: SB.CallOptions): SB.Call<Contact>
}

Emits Contact.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Contact.
`email`	`email`		The primary email address.
`phone`	`string`		The primary phone number.
`name`	`string`		The name the Contact goes by.

Returns

Output	Type	Required	Description
`contact`	Contact	required	The Contact.

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 contact = await $.Contact.update({ id: 'contact_WsrosCQi6J', email: 'dana@leaseline.app' })

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

TypeScript

interface ContactVerbs {
  delete(input: ContactDeleteInput, options?: SB.CallOptions): SB.Call<Contact>
}

Emits Contact.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`contact`	Contact	required	The Contact.

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 contact = await $.Contact.delete({ id: 'contact_WsrosCQi6J' })