Remove a phone number
Remove a phone number from a workspace: stop its Stripe rental billing, unassign it from any agent, and drop the workspace's claim. This does NOT release the number to the provider. It stays owned by Vertical AI and deletion-locked, so support can hand it back to this workspace or another one later. Same retain-don't-release path as the Remove button on the workspace's Phone numbers page. Releasing a number to the provider's public pool has no MCP tool on purpose; that stays a human action in the app. Use this too to clear a workspace row whose number no longer exists at the carrier (reconcile_phone_numbers reports those). Destructive: pass confirm: true.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Query Parameters
Must be true to perform this action. It deletes something, publishes, or changes what live callers get straight away, so confirm with the user first.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://example.com/workspaces/string/phone-numbers/string"{
"removed": "string",
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}List phone numbers GET
List the phone numbers provisioned in a workspace, with provider, status, friendly name, the monthly price in cents, when it was bought, and the id of the agent it answers for (null when unassigned). Assign one to an agent with assign_phone_number.
Send a text message from a number POST
Send a text message from one of the workspace's phone numbers (its id from list_phone_numbers) to up to 5 mobile numbers in international form, e.g. +61412345678. Use it to alert your team from your own systems, for example when a website form comes in. The sending number must be able to text: in Australia that is a mobile number (04xx), never a landline. Each text is billed as SMS usage, a workspace can send at most 30 an hour this way, and a message longer than one text is sent in parts. Returns each text sent with its message id, and each number it could not reach with the reason. Needs owner or admin.