Company methods: update
The Company Verbs update as typed SDK methods, with inputs, result, refusals and an example.
Reference for Company, one group of Company methods.
Company.update
Changes the given properties of a Company. Verb page.
interface CompanyVerbs {
update(input: CompanyUpdateInput, options?: SB.CallOptions): SB.Call<Company>
}Emits Company.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Company. |
name | string | The legal or personal name. | |
legalName | string | The registered name. | |
jurisdiction | string | Where it is incorporated. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
company | Company | required | The Company. |
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 company = await $.Company.update({ id: 'company_28zYNZEno0', legalName: 'Leaseline Inc.' })