PhoneNumbers

Update organization phone number settings

Updates phone number settings such as its optional label, assignment, messaging options, or warmup configuration.

put/phone-numbers/{phoneNumberId}

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/phone-numbers/{phoneNumberId}
  • Auth: HTTP bearer

Path parameters

phoneNumberIdstring required

The ID of the phone number to update.

Request body

namestring nullable

Human-readable label for the phone number.

numberHealthEnabledboolean nullable

Opts this number into the optional $2 monthly number health add-on. Defaults to on on creation; omitted updates preserve the current selection.

numberstring required

E.164 phone number exposed by this phone number update request.

Response

Returns the phone number response.

isDemoboolean
smsReadyboolean

Whether provider, routing, and health checks allow SMS.

voiceReadyboolean

Whether provider, routing, and health checks allow calls.

numberHealthEnabledboolean

Opts this number into the optional $2 monthly number health add-on. Defaults to on; customers can opt out.

numberstring

E.164 phone number exposed by this phone number.

phoneIdentityIdstring nullable

Identifier of the canonical phone identity for this number.

leadpingOwnedboolean

Indicates whether Leadping provisions and manages this phone number.

enabledboolean

Indicates whether this phone number is active and available in the Leadping API.

namestring
idstring
createdAtstring date-time
modifiedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.