Calls: Scheduled Callbacks The Scheduled Callbacks in your account. Calls will be placed to leads when the callback matches.

GET /api/v1/scheduled_callbacks
List scheduled callbacks.

Response Example

{
  "status" : 200,
  "errors" : {},
  "scheduled_callback" : {
    "id" : 89402,
    "created_at" : "2019-08-09T17:13:00.378-04:00",
    "updated_at" : "2019-08-09T17:13:00.378-04:00",
    "user_updated_at" : null,
    "company_id" : 28940,
    "lead_id" : 109923238,
    "collaborator_id" : 82904,
    "connect_with" : "me",
    "place_call_at" : "2019-08-12T13:00:00.000-04:00",
    "place_call_time_zone" : "Eastern Time (US & Canada)",
    "type" : "ScheduledCallback"
  },
  "checksum" : "e24b941d4634c11a32d09b11fc8588f0",
  "metadata" : {
    "root" : "scheduled_callback"
  }
}

GET /api/v1/scheduled_callbacks/new
Returns a new Scheduled Callback

Response Example

{
  "status" : 200,
  "errors" : {},
  "scheduled_callback" : {
    "id" : 89402,
    "created_at" : "2019-08-09T17:13:00.378-04:00",
    "updated_at" : "2019-08-09T17:13:00.378-04:00",
    "user_updated_at" : null,
    "company_id" : 28940,
    "lead_id" : 109923238,
    "collaborator_id" : 82904,
    "connect_with" : "me",
    "place_call_at" : "2019-08-12T13:00:00.000-04:00",
    "place_call_time_zone" : "Eastern Time (US & Canada)",
    "type" : "ScheduledCallback"
  },
  "checksum" : "e24b941d4634c11a32d09b11fc8588f0",
  "metadata" : {
    "root" : "scheduled_callback"
  }
}

Params

Param name
Description
call_id
Optional

The callback will be made against this call.
lead_id
Optional

The callback will be made against this lead.

POST /api/v1/scheduled_callbacks
Create a Scheduled Callback

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -X POST "trackdrive.com/api/v1/scheduled_callbacks?place_call_at=2024-04-23+05%3A16&place_call_time_zone=Eastern+Time+%28US+%26+Canada%29&schedule_id=12345678&to=%2B16053334444"

Response Example

{
  "status" : 200,
  "errors" : {},
  "scheduled_callback" : {
    "id" : 89402,
    "created_at" : "2019-08-09T17:13:00.378-04:00",
    "updated_at" : "2019-08-09T17:13:00.378-04:00",
    "user_updated_at" : null,
    "company_id" : 28940,
    "lead_id" : 109923238,
    "collaborator_id" : 82904,
    "connect_with" : "me",
    "place_call_at" : "2019-08-12T13:00:00.000-04:00",
    "place_call_time_zone" : "Eastern Time (US & Canada)",
    "type" : "ScheduledCallback"
  },
  "checksum" : "e24b941d4634c11a32d09b11fc8588f0",
  "metadata" : {
    "root" : "scheduled_callback"
  }
}

Params

Param name
Description
to
Optional Blank Value Allowed

The telephone number for the consumer who will receive a callback.

  • Must be String
schedule_id
Optional Blank Value Allowed

The schedule that the callback will be associated with.
call_id
Optional Blank Value Allowed

The callback will be made against this call.
lead_id
Optional Blank Value Allowed

The callback will be made against this lead.
connect_with
Required

Who Should The Consumer Talk To?

  • Must be one of: me, anyone, connect_with_buyer_id.
place_call_at
Required

When should the callback occur?

  • Must be a valid time: 2024-04-16 09:00:05 +0000
place_call_time_zone
Required

The time zone that will be used when parsing place_call_at

GET /api/v1/scheduled_callbacks/:id
Returns a Scheduled Callback by ID

Response Example

{
  "status" : 200,
  "errors" : {},
  "scheduled_callback" : {
    "id" : 89402,
    "created_at" : "2019-08-09T17:13:00.378-04:00",
    "updated_at" : "2019-08-09T17:13:00.378-04:00",
    "user_updated_at" : null,
    "company_id" : 28940,
    "lead_id" : 109923238,
    "collaborator_id" : 82904,
    "connect_with" : "me",
    "place_call_at" : "2019-08-12T13:00:00.000-04:00",
    "place_call_time_zone" : "Eastern Time (US & Canada)",
    "type" : "ScheduledCallback"
  },
  "checksum" : "e24b941d4634c11a32d09b11fc8588f0",
  "metadata" : {
    "root" : "scheduled_callback"
  }
}

Params

Param name
Description
call_id
Optional

The callback will be made against this call.
lead_id
Optional

The callback will be made against this lead.

PUT /api/v1/scheduled_callbacks/:id
Updates a Scheduled Callback by ID

Response Example

{
  "status" : 200,
  "errors" : {},
  "scheduled_callback" : {
    "id" : 89402,
    "created_at" : "2019-08-09T17:13:00.378-04:00",
    "updated_at" : "2019-08-09T17:13:00.378-04:00",
    "user_updated_at" : null,
    "company_id" : 28940,
    "lead_id" : 109923238,
    "collaborator_id" : 82904,
    "connect_with" : "me",
    "place_call_at" : "2019-08-12T13:00:00.000-04:00",
    "place_call_time_zone" : "Eastern Time (US & Canada)",
    "type" : "ScheduledCallback"
  },
  "checksum" : "e24b941d4634c11a32d09b11fc8588f0",
  "metadata" : {
    "root" : "scheduled_callback"
  }
}

Params

Param name
Description
connect_with
Required

Who Should The Consumer Talk To?

  • Must be one of: me, anyone, connect_with_buyer_id.
place_call_at
Required

When should the callback occur?

  • Must be a valid time: 2024-04-16 09:00:05 +0000
place_call_time_zone
Required

The time zone that will be used when parsing place_call_at

DELETE /api/v1/scheduled_callbacks/:id
Delete a Scheduled Callback by ID

Response Example

{
  "status" : 200,
  "errors" : {},
  "scheduled_callback" : {
    "id" : 89402,
    "created_at" : "2019-08-09T17:13:00.378-04:00",
    "updated_at" : "2019-08-09T17:13:00.378-04:00",
    "user_updated_at" : null,
    "company_id" : 28940,
    "lead_id" : 109923238,
    "collaborator_id" : 82904,
    "connect_with" : "me",
    "place_call_at" : "2019-08-12T13:00:00.000-04:00",
    "place_call_time_zone" : "Eastern Time (US & Canada)",
    "type" : "ScheduledCallback"
  },
  "checksum" : "e24b941d4634c11a32d09b11fc8588f0",
  "metadata" : {
    "root" : "scheduled_callback"
  }
}