Company routes: update · StartupBuilder

Reference for Company, one group of Company routes.

Company.update

Changes the given properties of a Company. Verb page.

Text

PATCH /{namespace}/companies/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

curl -X PATCH https://api.sb/leaseline.app/companies/company_28zYNZEno0 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"legalName":"Leaseline Inc."}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "company": {
    "$id": "https://api.sb/leaseline.app/companies/company_28zYNZEno0",
    "$type": "Company",
    "name": "Leaseline",
    "legalName": "Leaseline Inc.",
    "jurisdiction": "US-DE",
    "status": "forming"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Company.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Company.updateCopy Anchor Link

Company.update