Vendors

Edits a vendor; only the fields sent change.

Requires ManageVendors and an Idempotency-Key header. "" clears a field (not name); "isActive": false deactivates the vendor. Renaming onto another vendor's name is refused. Existing purchase orders keep the vendor name they were placed with. Example: PATCH /api/v1/vendors/7 { "contactPhone": "555-0199" }.

patch/api/v1/vendors/{id}

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/vendors/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Numeric vendor id. Example: 7.

Request body

namestring nullable

Vendor name, 1..100 characters, unique in the organization. Required on create. Example: Acme Supply.

descriptionstring nullable

Free-text notes, up to 500 characters.

contactNamestring nullable

Main contact's name, up to 100 characters.

contactEmailstring nullable

Main contact's email, up to 100 characters. Example: orders@acme.example.

contactPhonestring nullable

Main contact's phone, up to 20 characters. Example: 555-0100.

websitestring nullable

Vendor website, up to 500 characters.

defaultShippingCompanystring nullable

Carrier the vendor usually ships with, up to 100 characters. Example: UPS.

isActiveboolean nullable

False deactivates the vendor (kept for history, not offered on new orders). Defaults to true on create.

Response

The vendor after the edit.

idinteger

Numeric id, usable in /api/v1/vendors/{id} and as a purchase order's vendorId. Example: 7.

syncIdstring uuid

Stable cross-device id; also the pagination cursor.

namestring

Vendor name, unique in the organization. Example: Acme Supply.

descriptionstring nullable

Free-text notes about the vendor; null when not recorded.

contactNamestring nullable

Main contact's name; null when not recorded. Example: Dana Ruiz.

contactEmailstring nullable

Main contact's email; null when not recorded. Example: orders@acme.example.

contactPhonestring nullable

Main contact's phone, as typed; null when not recorded. Example: 555-0100.

websitestring nullable

Vendor website; null when not recorded. Example: https://acme.example.

defaultShippingCompanystring nullable

Carrier the vendor usually ships with; null when not recorded. Example: UPS.

isActiveboolean

False for a deactivated vendor: kept for history, not offered on new orders and refused as a new order's vendorId.

createdAtstring date-time

UTC creation time (ISO-8601).

updatedAtstring date-time

UTC last modification time (ISO-8601).

Changes

No recorded changes to this operation across all 1 revision of this API.