API documentation

GET /number_orders/new

Authorization Required

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

Build Number Order with defaults.

Builds a Number Order with default attributes without saving it.

Params

Param name	Description
offer_id Optional Blank value allowed	The offer the ordered numbers will be assigned to. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank value allowed	The number pool the ordered numbers will be added to. Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank value allowed	The traffic source the ordered numbers will be assigned to. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank value allowed	The schedule the ordered numbers will be assigned to. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank value allowed	The name of the number order. Must be a String
description Optional Blank value allowed	A description of the number order. Must be a String
provider_configuration_id Optional Blank value allowed	The provider the numbers will be purchased from. Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
paused Optional Blank value allowed	Pause the order so it stops purchasing numbers. Must be a boolean value: 1, true, yes, on, 0, false, no, off
fallback_to_any_number_in_state Optional Blank value allowed	When no number is available with the requested prefix, allow purchasing any available number in the same state. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order": {
    "id": null,
    "type": "NumberOrder",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_orders/new",
    "routes_edit_path": "/number_orders/new",
    "external_record_id": null,
    "paused": null,
    "offer_id": null,
    "ring_pool_id": null,
    "traffic_source_id": null,
    "schedule_id": null,
    "name": "Order By 1 person1@example.com At 2026-09-24",
    "description": null,
    "provider_configuration_id": 10001,
    "numbers_count": null,
    "fallback_to_any_number_in_state": null,
    "number_order_prefix_ids": []
  },
  "metadata": {
    "root": "number_order"
  }
}