Party routes: update, delete

Reference for Party, one group of Party routes.

Party.update

Changes the given properties of a Party. Verb page.

Text

PATCH /{namespace}/parties/{id}

Path: id. Body, as JSON: the other inputs. Emits Party.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Party.
`name`	`string`		The legal or personal name.

Returns

Output	Type	Required	Description
`party`	Party	required	The Party.

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/parties/party_hmQWaPrAyZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "party": {
    "$id": "https://api.sb/leaseline.app/parties/party_hmQWaPrAyZ",
    "$type": "Party",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Party.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Party.delete

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