Skip to main content

Bulk client actions

POST 
/api/v1/clients/bulk

POST /api/v1/clients/bulk​

Bulk actions allow to make changes to multiple clients in a single request the following actions are supported

  • archive
  • restore
  • delete
  • template requires template,template_id properties also
  • assign_group requires group_settings_id also
  • bulk_update requires column,new_value also

All of these actions require an array of client ids to perform the requested action on ie.

"ids":['id1','id2']

actions such as template, assign_group and bulk_update also require additional properties to be passed in the request

  • template

The template bulk action allows the creation of a custom template using the provided template_id to be run against the array of clients provided.

  • assign_group

Allows setting multiple clients to a single group

  • bulk_update

Allows updating certain columns on the client model in bulk. the current list of supported columns that can be updated archived_at:

  • public_notes
  • industry_id
  • size_id
  • country_id
  • custom_value1
  • custom_value2
  • custom_value3
  • custom_value4

Request​

Responses​

The Client list Response of the updated clients that were bulk updated

Response Headers
    X-MINIMUM-CLIENT-VERSION

    The API version

    X-RateLimit-Remaining

    The number of requests left for the time window.

    X-RateLimit-Limit

    The total number of requests in a given time window.

Last updated on