API documentation

GET /contacts/suppression_list

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contacts/suppression_list

List contacts on your company blacklist.

Returns the contacts your company has blocked - your do-not-call blacklist. A blocked contact cannot call or text in, and no outbound calls, SMS, or email are sent to it. Supports pagination and filtering by creation date or the date the contact was blocked. Requires the Suppression List permission.

Params

Param name	Description
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. Must be a valid time zone. See the list of valid time zones.
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 number last_call_at blocked opt_out calls_count outbound_call_failure_count outbound_no_answer_count blocked_at sms_opt_out_at 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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/contacts/suppression_list' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "contacts": [
    {
      "id": 10001,
      "type": "Contact",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contacts/10001",
      "routes_edit_path": "/contacts/10001/edit",
      "external_record_id": null,
      "number": "+19205559017",
      "last_call_at": null,
      "blocked": true,
      "opt_out": null,
      "calls_count": 0,
      "outbound_call_failure_count": 0,
      "outbound_no_answer_count": 0,
      "blocked_at": "2026-01-15T15:30:00.000Z",
      "sms_opt_out_at": null
    },
    {
      "id": 10002,
      "type": "Contact",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contacts/10002",
      "routes_edit_path": "/contacts/10002/edit",
      "external_record_id": null,
      "number": "+18135559016",
      "last_call_at": null,
      "blocked": true,
      "opt_out": null,
      "calls_count": 0,
      "outbound_call_failure_count": 0,
      "outbound_no_answer_count": 0,
      "blocked_at": "2026-01-15T15:30:00.000Z",
      "sms_opt_out_at": null
    }
  ],
  "metadata": {
    "root": "contacts",
    "page": 1,
    "total_pages": 1,
    "per_page": 25,
    "total_count": 2,
    "next_cursor": 10003
  }
}

POST /contacts/:caller_id/caller_block

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contacts/:caller_id/caller_block

Blacklist a caller ID

Add a caller_id to your company blacklist, preventing all inbound and outbound interactions.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/contacts/+18885551234/caller_block' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 204
}

POST /contacts/:caller_id/caller_unblock

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contacts/:caller_id/caller_unblock

Remove a caller from your company blacklist.

Removes a contact from your company blacklist so inbound calls and SMS from that number are accepted again and outbound calls, SMS, and email can resume. This only unblocks the contact itself - any Lead records that were separately blocked when the contact was blacklisted are not automatically unblocked. Requires superuser access.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/contacts/+18885551234/caller_unblock' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 204
}

GET /contacts/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contacts/:id

Get details about a contact.

Returns details for a single contact, including whether it is blocked or opted out. Look it up either by Trackdrive's internal contact id or by passing the full 10+ digit phone number as the id. Requires read permission on Contacts.

Params

Param name Description

Param name	Description
id Optional	Lookup a contact by internal id, or by the 10+ digit telephone number. For example: To find a number using trackdrive’s internal id pass `id=185923` To find a number using the phone number pass `id=18005002562` Must be a String
blocked Optional	Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms. Must be a boolean value: 1, true, yes, on, 0, false, no, off

id
Optional

Lookup a contact by internal id, or by the 10+ digit telephone number. For example:

To find a number using trackdrive’s internal id pass id=185923

To find a number using the phone number pass id=18005002562

Must be a String

blocked
Optional

Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms.

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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/contacts/+12125559001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact": {
    "id": 10001,
    "type": "Contact",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contacts/10001",
    "routes_edit_path": "/contacts/10001/edit",
    "external_record_id": null,
    "number": "+12125559001",
    "last_call_at": null,
    "blocked": false,
    "opt_out": null,
    "calls_count": 0,
    "outbound_call_failure_count": 0,
    "outbound_no_answer_count": 0,
    "blocked_at": null,
    "sms_opt_out_at": null
  },
  "metadata": {
    "root": "contact"
  }
}

PUT /contacts/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contacts/:id

Update a contact

Blocks or unblocks a contact, or marks it opted out/in for SMS. Blocking here affects only this contact record; opting out also opts out every Lead with the same phone number, preventing outbound contact while still letting them dial back in to resubscribe. Requires the Call Block permission.

Params

Param name Description

Param name	Description
id Optional	Lookup a contact by internal id, or by the 10+ digit telephone number. For example: To find a number using trackdrive’s internal id pass `id=185923` To find a number using the phone number pass `id=18005002562` Must be a String
opt_out Optional	Mark a contact as opt-out or opt-in. Opt-out prevents outbound actions (calls, sms, emails), but allows the lead to dial in to your offers to resubscribe. Must be a boolean value: 1, true, yes, on, 0, false, no, off
blocked Optional	Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms. Must be a boolean value: 1, true, yes, on, 0, false, no, off

id
Optional

Lookup a contact by internal id, or by the 10+ digit telephone number. For example:

To find a number using trackdrive’s internal id pass id=185923

To find a number using the phone number pass id=18005002562

Must be a String

opt_out
Optional

Mark a contact as opt-out or opt-in. Opt-out prevents outbound actions (calls, sms, emails), but allows the lead to dial in to your offers to resubscribe.

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

blocked
Optional

Block or unblock a contact. Block prevents outbound actions (calls, sms, emails), and also blocks all inbound calls & sms.

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

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/contacts/+12125559001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "opt_out": true
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact": {
    "id": 10001,
    "type": "Contact",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T14:30:00.000Z",
    "updated_at": "2026-01-15T14:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contacts/10001",
    "routes_edit_path": "/contacts/10001/edit",
    "external_record_id": null,
    "number": "+12125559001",
    "last_call_at": null,
    "blocked": false,
    "opt_out": true,
    "calls_count": 0,
    "outbound_call_failure_count": 0,
    "outbound_no_answer_count": 0,
    "blocked_at": null,
    "sms_opt_out_at": "2026-01-15T15:30:00.000Z"
  },
  "metadata": {
    "root": "contact"
  }
}

DELETE /contacts/:id/calls

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/contacts/:id/calls

Hang up a contact's ongoing calls

Ends any calls from this contact that are currently in progress, queuing the hangup right away - it does not delete call history or any records. Use it to stop a live call immediately, for example right after blocking a caller. Requires superuser access.

Params

Param name	Description
uuid Optional	A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1 Must be a String

Param name

Description

uuid
Optional

A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1

Must be a String

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/contacts/+12125559001/calls' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact": {
    "id": 10001,
    "type": "Contact",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contacts/10001",
    "routes_edit_path": "/contacts/10001/edit",
    "external_record_id": null,
    "number": "+12125559001",
    "last_call_at": null,
    "blocked": false,
    "opt_out": null,
    "calls_count": 0,
    "outbound_call_failure_count": 0,
    "outbound_no_answer_count": 0,
    "blocked_at": null,
    "sms_opt_out_at": null
  },
  "metadata": {
    "root": "contact"
  }
}

Params

Must be any combination of:

Params

Params

Params