Sign in

v10

latestSwagger 2.02026-07-13203270.7 KB
Browse, reserve and purchase available phone numbers

Creates or updates a reservation by its ID.

Adds and removes phone numbers from the reservation with the given ID. The response will be the updated state of the reservation. Phone numbers can be reserved by including them in the payload. If a number is already in the reservation, it will be ignored. To remove a phone number, set it explicitly to null in the request payload. This operation is idempotent. If a reservation with the same ID already exists, it will be updated, otherwise a new one is created. Only reservations with 'active' status can be updated. Updating a reservation will extend the expiration time of the reservation to 15 minutes after the last change, up to a maximum of 2 hours from creation time. Partial success is possible, in which case the response will have a 207 status code.

patch/availablePhoneNumbers/reservations/{reservationId}

Path parameters

reservationIdstring uuid required

The id of the reservation.

Query parameters

api-versionstring required

Version of API to invoke

Response

Reservation successfully updated.

idstring uuid

The id of the reservation.

expiresAtstring date-time

The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase.

phoneNumbersobject

A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections.

status'active' | 'submitted' | 'completed' | 'expired'

Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'.