Company programs: update · StartupBuilder

Reference for Company, one group of Company programs.

Company.update

Changes the given properties of a Company. Verb page.

Text

do: return await $.Company.update(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Company.update({ id: 'company_28zYNZEno0', legalName: 'Leaseline Inc.' })"
  }
}