Path parameters

• PortInRequestSid string Required

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

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KW[0-9a-fA-F]{32}$.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • port_in_request_sid string | null

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KW[0-9a-fA-F]{32}$.

  • url string(uri) | null

    The URL of this Port In request

  • account_sid string | null

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • notification_emails array[string] | null

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

  • target_port_in_date string(date) | null

    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_start string | null

    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_end string | null

    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

  • port_in_request_status string | null

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

  • losing_carrier_information object | null

    Details regarding the customer’s information with the losing carrier. These values will be used to generate the letter of authorization and should match the losing carrier’s data as closely as possible to ensure the port is accepted.

  • phone_numbers array | null
  • documents array[string] | null

    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_created string(date-time) | null