POST /schedule_agents

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

Create Agent with Wizard.

Creates a new agent, and its underlying user account, via the Agent Wizard. Specify buyer_type (quality_assurance or buyer) and whether the agent is internal; internal agents only have access to your company and sign in with a random password. When the caller is an administrator or manager, this response returns it once as internal_password; store it, since no other response includes it.

Params

Param name Description
first_name
Required

First Name

  • Must be a String
email
Optional Blank value allowed

Email

  • Must be a String
is_internal
Optional Blank value allowed

Internal agents only have access to your company. The create response returns the agent’s password once as internal_password to an administrator or manager; an administrator or manager can generate a new one on the agent’s page.

  • 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 a String
internal_username
Optional Blank value allowed

Username

  • Must be a String
last_name
Optional Blank value allowed

Last Name

  • Must be a String
company_name
Optional Blank value allowed

Company Name

  • Must be a String
phone_number
Optional Blank value allowed

Phone Number

  • Must be a String
address_state
Optional Blank value allowed

Address State

  • Must be a String
address_city
Optional Blank value allowed

Address City

  • Must be a String
address_country
Optional Blank value allowed

Address Country

  • Must be a String
address_zip
Optional Blank value allowed

Address Zip

  • Must be a String
address_line1
Optional Blank value allowed

Address Line1

  • Must be a String
address_line2
Optional Blank value allowed

Address Line2

  • Must be a String
call_center_id
Optional Blank value allowed

Does this agent belong to a call center?
profile_image
Optional Blank value allowed

A photo to display on the agent’s profile, 200px by 200px.

  • Must be a valid file upload.
remove_profile_image
Optional Blank value allowed

Set to true to remove the agent’s existing profile photo.

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

The phone number or SIP address calls are forwarded to for this agent.

  • Must be a String
number_id
Optional Blank value allowed

The phone number shown as the caller ID to consumers when this agent places outbound calls.