Vendor Bulk Action

Operates on Vendors. In the Zuper client app this module is labeled "Vendor" for most companies, and "Supplier" for companies in the roofing industry — the API and data shape are identical either way. Vendors and Subcontractors share the exact same underlying schema and endpoints; they're distinguished only by the vendor_type field (VENDOR here) and the /vendors vs /subcontractors route prefix. Supports activate, send_email, send_sms, and delete. Activate/email are processed asynchronously by a background worker. Delete skips (and reports back) any record that is a favorite supplier or set as a product's preferred vendor.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
vendor_uid
array of strings

UIDs to target. Alternative to filter_rules.

vendor_uid
filter_rules
array of objects
filter_rules
string
enum
Defaults to AND
Allowed:
string
enum
required
Allowed:
action_options
object

Shape depends on action: activate{is_active: boolean}; send_email{cc?: string[], bcc?: string[]}; send_sms{sms_body: string} (Handlebars template); delete → no fields.

boolean
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json