Blacklist: Clear Blacklist

API resource for removing all numbers from your blacklist.

GET /unblock_contact_jobs

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/unblock_contact_jobs

List Clear Blacklist records.

List the bulk Clear Blacklist jobs that have been run or queued for your account, including their progress and completion status.

Params

Param name Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
page
Optional

Return the next page of results.

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.
created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.
columns
Optional 		Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • user_id
  • description
  • succeeded_at
  • blocked_at_from
  • blocked_at_to
  • request_ip
  • last_contact_id
  • unblock_count

  • Must be a String
root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /unblock_contact_jobs/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/unblock_contact_jobs/new

Build Clear Blacklist with defaults.

Return a blank Clear Blacklist job populated with default attribute values, useful for building a create form.

Params

Param name Description
description
Optional Blank value allowed

Description

  • Must be a String
blocked_at_from
Optional Blank value allowed

Blocked At From

  • Must be a valid time: 2026-10-07 02:33:44 +0000
blocked_at_to
Optional Blank value allowed

Blocked At To

  • Must be a valid time: 2026-10-07 02:33:44 +0000
request_ip
Optional Blank value allowed

Request Ip

  • Must be a String
last_contact_id
Optional Blank value allowed

Last Contact

  • Must be a String

POST /unblock_contact_jobs

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/unblock_contact_jobs

Create Clear Blacklist.

Queue a bulk job that unblocks every blacklisted contact whose blocked_at falls within the given date range. The job runs asynchronously in the background; check its status via the show endpoint.

Params

Param name Description
description
Optional Blank value allowed

Description

  • Must be a String
blocked_at_from
Optional Blank value allowed

Blocked At From

  • Must be a valid time: 2026-10-07 02:33:44 +0000
blocked_at_to
Optional Blank value allowed

Blocked At To

  • Must be a valid time: 2026-10-07 02:33:44 +0000
request_ip
Optional Blank value allowed

Request Ip

  • Must be a String
last_contact_id
Optional Blank value allowed

Last Contact

  • Must be a String

GET /unblock_contact_jobs/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/unblock_contact_jobs/:id

Get Clear Blacklist by id.

Get the status and progress of a single Clear Blacklist job by id.

DELETE /unblock_contact_jobs/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/unblock_contact_jobs/:id

Destroy Clear Blacklist by id.

Cancels a Clear Blacklist job by id, so it stops making further progress if it has not finished. The record is retained but excluded from future index and show results.