ZUzuper

Vendor Bulk Action

Changed on

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.

post/vendors/bulk_action

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/vendors/bulk_action
  • Auth
    API key in header x-api-key

Request body

vendor_uidstring[]

UIDs to target. Alternative to filter_rules.

filter_rulesobject[]
filter_rule_operator'AND' | 'OR'
action'activate' | 'send_email' | 'send_sms' | 'delete' required
action_optionsobject

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

update_statusboolean

Response

200

type'SUCCESS'
titlestring
messagestring

Changes