Partner routes: update, delete

Reference for Partner, one group of Partner routes.

Partner.update

Changes the given properties of a Partner. Verb page.

Text

PATCH /{namespace}/partners/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Partner.
`name`	`string`		The name it trades under.
`hostname`	`string`		The web domain that keys it.
`side`	`string`		One of `supply`, `distribution`, or `both`.

Returns

Output	Type	Required	Description
`partner`	Partner	required	The Partner.

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/partners/partner_YcEOEgSexq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"side":"supply"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "partner": {
    "$id": "https://api.sb/leaseline.app/partners/partner_YcEOEgSexq",
    "$type": "Partner",
    "name": "Leaseline",
    "side": "supply"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Partner.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Partner.delete

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