Skip to main content
PUT
Update business phone number settings

Path Parameters

phoneNumberId
string
required

The ID of the phone number to update.

Body

The updated phone number details.

Request schema for the Leadping API phone number update request, including the fields clients can send.

name
string
required

The display name for the entity.

Maximum string length: 255
number
string

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

businessId
string | null

Business ID that owns the phone number being created or updated.

enabled
boolean

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

id
string | null

The unique identifier for the entity, when updating an existing entity.

Response

Returns the phone number response.

Response schema for the Leadping API phone number returned to authenticated clients.

number
string

E.164 phone number exposed by this phone number.

phoneIdentityId
string | null

Identifier of the canonical phone identity for this number.

business
object | null

Business summary connected to this phone number.

leadpingOwned
boolean

Indicates whether Leadping provisions and manages this phone number.

routing
object

Routing metadata that connects this phone number to teams, campaigns, and sources.

enabled
boolean

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

warmup
object

SMS and call warmup for this phone number.

name
string

The display name for the entity.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.