Bulk Action Customer

Performs a bulk action on a set of customers. The customer set is determined by an explicit customer_uid array, filter_rules (v3), and/or the legacy filter object — all three can be combined; customer_uid narrows additively. Role-based scoping is always applied on top: a Field Executive only sees their own records, a Team Leader only their team's (unless the company allows viewing all).

delete, activate, and update_field apply synchronously. send_email and send_sms respond before the per-customer send loop finishes (fire-and-forget relative to the response). send_customer_ar_aging_statement is fully asynchronous — it queues a worker job and responds immediately with just an acknowledgement.

activate's is_active is toggle-style: the request is automatically scoped to customers NOT already in the target state before applying it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
Allowed:
customer_uid
array of strings

Optional explicit list of customer uids. Combined additively ($in) with filter_rules/filter.

customer_uid
filter_rules
array of objects

v3 filter engine rules used to select the customer set.

filter_rules
filter
object

Legacy filter object. For send_customer_ar_aging_statement with no customer_uid given, also supports filter.aging_period (comma list of 30_day, 60_day, 90_day, above_90, current) and filter.due_date_from / filter.due_date_to.

action_options
object
Responses

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