API documentation

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

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: 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 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 Validations: 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: {}}` Validations: 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.

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

Params

Param name	Description Validations
first_name Required	First Name Validations: Must be a String
is_internal Optional Blank Value Allowed	Internal agents only have access to your company and have a predefined password. Validations: 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 Validations: Must be a String
email Optional Blank Value Allowed	Email Validations: Must be a String
internal_username Optional Blank Value Allowed	Username Validations: Must be a String
last_name Optional Blank Value Allowed	Last Name Validations: Must be a String
company_name Optional Blank Value Allowed	Company Name Validations: Must be a String
phone_number Optional Blank Value Allowed	Phone Number Validations: Must be a String
address_state Optional Blank Value Allowed	Address State Validations: Must be a String
address_city Optional Blank Value Allowed	Address City Validations: Must be a String
address_country Optional Blank Value Allowed	Address Country Validations: Must be a String
address_zip Optional Blank Value Allowed	Address Zip Validations: Must be a String
address_line1 Optional Blank Value Allowed	Address Line1 Validations: Must be a String
address_line2 Optional Blank Value Allowed	Address Line2 Validations: Must be a String
call_center_id Optional Blank Value Allowed	Does this agent belong to a call center? Validations: Must be a valid foreign key reference to an Call Center. Refer to: /api/docs/1.0/call_centers

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

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

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