API documentation

GET /schedule_agents/new

Authorization Required

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

Build Agent Wizard record with defaults.

Builds an Agent Wizard record with default attributes without saving it.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_agent": {
    "id": null,
    "type": "ScheduleAgent",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/schedule_agents/new",
    "routes_edit_path": "/schedule_agents/new",
    "external_record_id": null,
    "company_id": 10001,
    "sortable_order": null,
    "first_name": "agent-da771aa5",
    "last_name": null,
    "company_name": null,
    "email": null,
    "phone_number": null,
    "address_state": null,
    "address_city": null,
    "address_country": null,
    "address_zip": null,
    "address_line1": null,
    "address_line2": null,
    "collaborator_id": null,
    "buyer_id": null,
    "internal_password": null,
    "profile_image_url": null,
    "buyer_type": "quality_assurance",
    "agent_number": null,
    "number_id": null,
    "is_internal": true,
    "internal_username": "agent-da771aa5",
    "softphone_sip_url": null,
    "softphone_password": null,
    "softphone_username": null,
    "call_center_id": null
  },
  "metadata": {
    "root": "schedule_agent"
  }
}