Skip to content
Vocapable Developers

Queue a pre-campaign scrub of a contact list

POST
/v1/scrub-runs
curl --request POST \
  --url https://api.vocapable.com/v1/scrub-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "target": { "contact_list_id": "example" } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ScrubRunCreateRequest
object
target
required
ScrubRunTarget
object
contact_list_id
required
Contact List Id
string
Examplegenerated
{
  "target": {
    "contact_list_id": "example"
  }
}

Responses

Section titled “Responses”

202

Section titled “202”

Successful Response

Media typeapplication/json
ScrubRun

The customer-facing scrub report.

object
id
required
Id
string
contact_list_id
required
Any of:
string
status
required
JobStatus

Lifecycle shared by the async import and export jobs.

string
Allowed values: queued running completed failed
totals
required
ScrubRunTotals

The funnel a launch is authorized against.

object
contacts
required
Contacts
integer
dialable
required
Dialable
integer
blocked
required
Blocked
integer
flagged
required
Flagged
integer
blocked_breakdown
Blocked Breakdown
object
key
additional properties
integer
risk_flags
Risk Flags
Array<string>
dataset_versions
Dataset Versions
object
key
additional properties
string
waived_stages
Waived Stages
Array<object>
WaivedStage

A bureau stage a signed attestation elected out of.

Reported so a stage that did not run never reads as a stage that found nothing. Under ADR-0018 the election is a condition of production activation rather than a preference, which is why the signer is reported next to the reference: the report has to say whose signature the missing stage stands on.

object
stage
required
Stage
string
attestation_ref
Any of:
string
attested_by
Any of:
string
started_at
Any of:
string format: date-time
completed_at
Any of:
string format: date-time
expires_at
Any of:
string format: date-time
is_stale
Is Stale
boolean
acknowledged_by
Any of:
string
acknowledged_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
Example
{
  "status": "queued",
  "is_stale": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}