Apply a tag or list change to every contact matching a filter
Changed onQueues one action against every contact the filter matches, applied in chunks in the background. Returns immediately with an id to poll.
Run with dry_run: true first. A dry run reports how many contacts match and changes nothing — it is the only way to catch a filter that matches more than intended, and a bulk write is not undoable. An empty filter (which would match the whole account) is rejected unless it is a dry run.
Per-campaign conditions (opened_campaign_id, not_opened_campaign_id, clicked_campaign_id) are available here but not on GET /contacts, because they are resolved in the background rather than inside a request.
Bulk delete and bulk unsubscribe are deliberately not offered.
Because in_list_ids matches only subscribed members, remove_from_list with filter.in_list_ids set to that same list leaves the memberships of people who unsubscribed from it in place. They already receive nothing from that list.
tag_ids behaves the same way, so remove_tag with filter.tag_ids set to that same tag leaves the tag on people who unsubscribed from it. They already receive nothing sent to that tag. To reach every carrier regardless of opt-out status, select them by some other filter, or read them from the tag endpoints.
Request
- Base URLhttps://api.sendfox.com
- AuthOAuth 2Authorization codehttps://sendfox.com/oauth/authorizeToken URLhttps://sendfox.com/oauth/token
Request body
Response
Queued
Changes
- info
added the new
bounce_pausedenum value to the request property/ - info
added the non-success response with the status
- info
- info
endpoint added
- info