GET /api/v1/schedule_agents
List Agent Wizard records.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

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 String

created_at_from
Optional

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

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be 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
  • company_id
  • sortable_order
  • first_name
  • last_name
  • company_name
  • email
  • phone_number
  • address_state
  • address_city
  • address_country
  • address_zip
  • address_line1
  • address_line2
  • collaborator_id
  • buyer_id
  • internal_password
  • profile_image_url
  • buyer_type
  • agent_number
  • number_id
  • is_internal
  • internal_username
  • softphone_sip_url
  • softphone_password
  • softphone_username
  • call_center_id
  • Must be 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 /api/v1/schedule_agents/new
Build Agent Wizard record with defaults.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


POST /api/v1/schedule_agents
Create Agent with Wizard.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

first_name
Required

First Name

  • Must be String

is_internal
Optional Blank Value Allowed

Internal agents only have access to your company and have a predefined password.

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

buyer_type
Optional Blank Value Allowed

What type of Agent is this? Either quality_assurance or buyer

  • Must be String

email
Optional Blank Value Allowed

Email

  • Must be String

internal_username
Optional Blank Value Allowed

Username

  • Must be String

last_name
Optional Blank Value Allowed

Last Name

  • Must be String

company_name
Optional Blank Value Allowed

Company Name

  • Must be String

phone_number
Optional Blank Value Allowed

Phone Number

  • Must be String

address_state
Optional Blank Value Allowed

Address State

  • Must be String

address_city
Optional Blank Value Allowed

Address City

  • Must be String

address_country
Optional Blank Value Allowed

Address Country

  • Must be String

address_zip
Optional Blank Value Allowed

Address Zip

  • Must be String

address_line1
Optional Blank Value Allowed

Address Line1

  • Must be String

address_line2
Optional Blank Value Allowed

Address Line2

  • Must be String

call_center_id
Optional Blank Value Allowed

Does this agent belong to a call center?


GET /api/v1/schedule_agents/:id
Get Agent Wizard record by id.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


PUT /api/v1/schedule_agents/:id
Update Agent Wizard record by id.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


DELETE /api/v1/schedule_agents/:id
Destroy Agent Wizard record by id.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String