Supplier routes: update, delete

Reference for Supplier, one group of Supplier routes.

Supplier.update

Changes the given properties of a Supplier. Verb page.

Text

PATCH /{namespace}/suppliers/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Supplier.
`name`	`string`		The legal or personal name.
`payoutAccount`	`string`		Where payouts land, held through Stripe.

Returns

Output	Type	Required	Description
`supplier`	Supplier	required	The Supplier.

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/tutorloop.com/suppliers/supplier_QTsIMiLqO4 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"payoutAccount":"Example payout account"}'

JSON

{
  "api": "https://api.sb/tutorloop.com",
  "supplier": {
    "$id": "https://api.sb/tutorloop.com/suppliers/supplier_QTsIMiLqO4",
    "$type": "Supplier",
    "name": "TutorLoop",
    "status": "recruited",
    "payoutAccount": "Example payout account"
  },
  "action": {
    "$id": "https://api.sb/tutorloop.com/actions/act_DEVhiF6mF5",
    "operation": "Supplier.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/tutorloop.com/actions/act_DEVhiF6mF5"
  }
}

Supplier.delete

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