Toll Free Automated Activation
Overview
If your account is enabled for Toll Free Activation Automation, once your toll free port-in order has received Firm Order Commitment (FOC) from the losing carrier, you can use this API to activate your numbers immediately. This gives you direct control over activation timing. If you take no action, your order will activate automatically on its set date and time.
Endpoint:
PUT /accounts/{accountId}/portins/{orderId}/activationStatus
Order State Requirements
Your port-in order must meet all of the following conditions before the API will accept the request:
| Condition | Details |
|---|---|
| Order must be in FOC status | Requests on orders in SUBMITTED, EXCEPTION, COMPLETE, or CANCELLED state are rejected. |
| FOC date confirmed | The order must have an ActualFocDate confirmed by the losing carrier. |
| Numbers not yet activated | The toll free numbers on the order must not already be activated. |
| Not an internal port-in | On-demand activation through this API is not supported for internal toll free port-ins (ports within Bandwidth's own network). |
Triggering Immediate Activation
To activate immediately, omit the AutoActivationDate or set it to a date in the past. The system will attempt to activate your numbers right away, subject to the RouteTrust activation window.
The activation request must fall within Bandwidth's RouteTrust activation window (8:00 AM–6:00 PM ET). Requests outside this window will be rejected with an error showing the allowed start and end times.
If the current time falls outside the activation window at the moment of processing, the activation will not be executed and no error is returned. Your order retains its scheduled activation date and activation will be attempted when conditions allow.
What Happens During Activation
When on-demand activation is triggered, the system performs the following steps automatically:
- The toll free numbers are marked as activated.
- The downstream toll free porting pipeline is triggered to complete the full activation process.
Response
On a successful request the API returns:
| Field | Description |
|---|---|
activationDate | The confirmed activation date and time at which activation was triggered. |
errors | Any errors encountered during processing, if applicable. |
The lists of activated and not-yet-activated telephone numbers are not included in the response for toll free orders.