Sign in
NumbersV1PortingPortIn

Allows to create a new port in request

Allows to create a new port in request

post/v1/Porting/PortIn

Request body

account_sidstring required

Account Sid or subaccount where the phone number(s) will be Ported

documentsstring[] required

List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.

notification_emailsstring[] nullable

Additional emails to send a copy of the signed LOA to.

target_port_in_datestring date nullable

Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. We can't guarantee the exact date and time, as this depends on the losing carrier

target_port_in_time_range_startstring nullable

The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier

target_port_in_time_range_endstring nullable

The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier

bundle_sidstring nullable

The bundle sid is an optional identifier to reference a group of regulatory documents for a port request.

portability_advance_carrierstring nullable

A field only required for Japan port in requests. It is a unique identifier for the donor carrier service the line is being ported from.

auto_cancel_approval_numbersstring nullable

Japan specific field, indicates the number of phone numbers to automatically approve for cancellation.

Response

Accepted

port_in_request_sidstring nullable

The SID of the Port In request. This is a unique identifier of the port in request.

urlstring uri nullable

The URL of this Port In request

account_sidstring nullable

Account Sid or subaccount where the phone number(s) will be Ported

notification_emailsstring[] nullable

Additional emails to send a copy of the signed LOA to.

target_port_in_datestring date nullable

Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. If a start and end range is provided, the date will be converted to its UTC equivalent with the ranges as reference and stored in UTC. We can't guarantee the exact date and time, as this depends on the losing carrier.

target_port_in_time_range_startstring nullable

The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.

target_port_in_time_range_endstring nullable

The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00'. We can't guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.

port_in_request_statusstring nullable

The status of the port in request. The possible values are: In progress, Completed, Expired, In review, Waiting for Signature, Action Required, and Canceled.

order_cancellation_reasonstring nullable

If the order is cancelled this field will provide further context on the cause of the cancellation.

bundle_sidstring nullable

The bundle sid is an optional identifier to reference a group of regulatory documents for a port request.

portability_advance_carrierstring nullable

A field only required for Japan port in requests. It is a unique identifier for the donor carrier service the line is being ported from.

auto_cancel_approval_numbersstring nullable

Japan specific field, indicates the number of phone numbers to automatically approve for cancellation.

documentsstring[] nullable

List of document SIDs for all phone numbers included in the port in request. At least one document SID referring to a document of the type Utility Bill is required.

date_createdstring date-time nullable
support_ticket_idinteger

Unique ID of the request's support ticket

signature_request_urlstring uri nullable

Changes

Changed in 11 of the 54 revisions of this API.1340

  • v110451ddb73911See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v11c28334ee36a1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v16c68a5c0ef431See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v11d4cee03cf21632See the full diff
    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      request body became required

      request-body-became-required

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the required property / to the response with the status

      response-required-property-added

    • ○

      added the required property / to the response with the status

      response-required-property-added

    • ○

      added the required property / to the response with the status

      response-required-property-added

  • v1921e3e4fb03613See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v152ed2eb207ab1See the full diff
    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

  • v12d7d1abf62872See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

  • v1e0028979b1382See the full diff
    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

  • v1332ce8f70e641See the full diff
    • ▲

      the response's property format changed from date to date-time for status

      response-property-type-changed

  • v1770aee798b511See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added