Skip to content
Get started
V2 Reference
Phone Numbers

Update Phone Number

PUT
/api/partner/v2/phone_numbers/{id}
curl --request PUT \
--url https://api.linqapp.com/api/partner/v2/phone_numbers/1 \
--header 'Content-Type: application/json' \
--header 'X-LINQ-INTEGRATION-TOKEN: <X-LINQ-INTEGRATION-TOKEN>' \
--data '{ "forwarding_number": "+15551234567" }'

Updates the forwarding number for a phone number. The forwarding number is where calls will be forwarded to when the primary number is unavailable.

Pass an empty string to clear the forwarding number.

id
required
integer

The phone number ID

Media type application/json
object
forwarding_number

The phone number to forward calls to when unavailable (pass empty string to clear)

string
nullable
Example
+15551234567

Phone number updated successfully

Media type application/json
object
id
integer
phone_number
string
forwarding_number

Phone number where calls are forwarded when this number is unavailable

string
nullable
response_rate

Response rate as messages per second

integer
Example
{
"id": 99,
"phone_number": "+19498151221",
"forwarding_number": null,
"response_rate": 75
}

Forbidden - Phone number doesn’t belong to your organization

Media type application/json

Standard error format used by most endpoints (render_error format)

object
errors
Array<object>
object
status
integer
code
string
title
string
detail
string
Example
{
"errors": [
{
"status": 403,
"code": "forbidden",
"title": "Forbidden",
"detail": "This phone number doesn't belong to your organization"
}
]
}

Unprocessable entity - Invalid forwarding number

Media type application/json

Standard error format used by most endpoints (render_error format)

object
errors
Array<object>
object
status
integer
code
string
title
string
detail
string
Example
{
"errors": [
{
"status": 422,
"code": "invalid_request",
"title": "Invalid Request",
"detail": "Forwarding number is invalid"
}
]
}