c5728da3037f

latestOpenAPI 3.0.32026-08-10601779.8 KB

Contacts

Check the progress of a bulk contact action

For a dry run, matched_count is the answer and nothing was modified. A run whose match set exceeds the per-request ceiling fails without applying anything.

get/contacts/bulk-actions/{id}

Response

Successful response

idinteger

status'pending' | 'processing' | 'completed' | 'failed'

action'apply_tag' | 'remove_tag' | 'add_to_list' | 'remove_from_list'

target_idinteger

dry_runboolean

filterstring

Human-readable rendering of the filter that was applied

matched_countinteger nullable

Number of contacts the filter matched; null until counted

processed_countinteger

errorstring nullable

started_atstring date-time nullable

completed_atstring date-time nullable