Change Updates

Do not miss any Taskrouter API changes, ever again

Subscribe to the Taskrouter API changelog to be up to date on recent changes.

RSS

Jul 29, 2025

main
1.0.0
Compare
1.0.0

API structure has changed

Next change
39 structure changes including:
1 Addition
38 Modifications
Modified 38 Breaking
GET /v1/Workspaces
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workspaces property Modified
        • prioritize_queue_order property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • channels property Modified
        • assigned_tasks, available_capacity_percentage, configured_capacity properties Modified
          • Type went from integer | null to integer
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_tasks, available_capacity_percentage, configured_capacity properties Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reservations property Modified
        • reservation_status property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reservation_status property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Workflows
  • Response
  • 200 response Modified
    • application/json content type Modified
      • workflows property Modified
        • task_reservation_timeout property Modified
          • Type went from integer | null to integer
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task_reservation_timeout property Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/CumulativeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • avg_task_acceptance_time, reservations_created, reservations_accepted, reservations_rejected, reservations_timed_out, reservations_canceled, reservations_rescinded, tasks_canceled, tasks_completed, tasks_entered, tasks_deleted, tasks_moved, tasks_timed_out_in_workflow properties Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • longest_task_waiting_age, total_tasks properties Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Workspaces
  • Response
  • 201 response Modified
    • application/json content type Modified
      • prioritize_queue_order property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Workspaces/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prioritize_queue_order property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Workspaces/{WorkspaceSid}/TaskQueues
  • Response
  • 201 response Modified
    • application/json content type Modified
      • max_reserved_workers property Modified
        • Type went from integer | null to integer
          Breaking
      • task_order property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • max_reserved_workers property Modified
        • Type went from integer | null to integer
          Breaking
      • task_order property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Workspaces/{WorkspaceSid}/Tasks
  • Body
  • application/x-www-form-urlencoded content type Modified
    • VirtualStartTime, RoutingTarget, IgnoreCapacity, TaskQueueSid properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • age, priority, timeout properties Modified
        • Type went from integer | null to integer
          Breaking
      • assignment_status property Modified
        • Type went from string | null to string
          Breaking
      • virtual_start_time, ignore_capacity, routing_target properties Added
POST /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • VirtualStartTime property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • age, priority, timeout properties Modified
        • Type went from integer | null to integer
          Breaking
      • assignment_status property Modified
        • Type went from string | null to string
          Breaking
      • virtual_start_time, ignore_capacity, routing_target properties Added
POST /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • JitterBufferSize property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reservation_status property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • assigned_tasks, available_capacity_percentage, configured_capacity properties Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}
  • Body
  • application/x-www-form-urlencoded content type Modified
    • JitterBufferSize property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reservation_status property Modified
        • Type went from string | null to string
          Breaking
POST /v1/Workspaces/{WorkspaceSid}/Workflows
  • Response
  • 201 response Modified
    • application/json content type Modified
      • task_reservation_timeout property Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task_reservation_timeout property Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • prioritize_queue_order property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Activities
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • avg_task_acceptance_time, reservations_created, reservations_accepted, reservations_rejected, reservations_timed_out, reservations_canceled, reservations_rescinded, tasks_canceled, tasks_completed, tasks_created, tasks_deleted, tasks_moved, tasks_timed_out_in_workflow properties Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/RealTimeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • longest_task_waiting_age, total_tasks, total_workers properties Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/TaskChannels
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/TaskQueues
  • Response
  • 200 response Modified
    • application/json content type Modified
      • task_queues property Modified
        • max_reserved_workers property Modified
          • Type went from integer | null to integer
            Breaking
        • task_order property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Ordering, Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • max_reserved_workers property Modified
        • Type went from integer | null to integer
          Breaking
      • task_order property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • avg_task_acceptance_time, reservations_created, reservations_accepted, reservations_rejected, reservations_timed_out, reservations_canceled, reservations_rescinded, tasks_canceled, tasks_completed, tasks_deleted, tasks_entered, tasks_moved properties Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • longest_task_waiting_age, longest_relative_task_age_in_queue, total_available_workers, total_eligible_workers, total_tasks properties Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Tasks
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tasks property Modified
        • age, priority, timeout properties Modified
          • Type went from integer | null to integer
            Breaking
        • assignment_status property Modified
          • Type went from string | null to string
            Breaking
        • virtual_start_time, ignore_capacity, routing_target properties Added
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • RoutingTarget, Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • age, priority, timeout properties Modified
        • Type went from integer | null to integer
          Breaking
      • assignment_status property Modified
        • Type went from string | null to string
          Breaking
      • virtual_start_time, ignore_capacity, routing_target properties Added
GET /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reservations property Modified
        • reservation_status property Modified
          • Type went from string | null to string
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • WorkerSid, Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reservation_status property Modified
        • Type went from string | null to string
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Workers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Ordering, Page, PageToken query parameters Added
GET /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reservations_created, reservations_accepted, reservations_rejected, reservations_timed_out, reservations_canceled, reservations_rescinded properties Modified
        • Type went from integer | null to integer
          Breaking
GET /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics
  • Response
  • 200 response Modified
    • application/json content type Modified
      • total_workers property Modified
        • Type went from integer | null to integer
          Breaking
Added 1
POST /v1/Workspaces/{WorkspaceSid}/TaskQueues/RealTimeStatistics