Skip to main content
PATCH
/
api
/
v1
/
phone-numbers
/
{uuid}
Update channel settings
curl --request PATCH \
  --url https://{subdomain}.mihu.ai/api/v1/phone-numbers/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_settings": {
    "voice": {
      "enabled": true,
      "channel_limit": 123,
      "whitelisted_destinations": [
        "US"
      ]
    },
    "sms": {
      "enabled": true,
      "channel_limit": 123,
      "whitelisted_destinations": [
        "<string>"
      ]
    },
    "inbound": {
      "enabled": true,
      "channel_limit": 123
    }
  }
}
'
{
  "success": true,
  "data": {
    "phone_number_uuid": "9bcb8f00-c0c5-4ee1-9b75-ad1e87a2bd8b",
    "number": "+12084439178",
    "country_code": "US",
    "location": "Sassari, Sardegna",
    "is_external": true,
    "compliance": {
      "requirements": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ]
    },
    "capabilities": {
      "voice": true,
      "sms": true,
      "mms": true,
      "fax": true,
      "emergency": true,
      "local_calling": true
    },
    "channel_settings": {
      "voice": {
        "enabled": true,
        "channel_limit": 123,
        "whitelisted_destinations": [
          "US"
        ]
      },
      "sms": {
        "enabled": true,
        "channel_limit": 123,
        "whitelisted_destinations": [
          "US"
        ]
      },
      "inbound": {
        "enabled": true,
        "channel_limit": 123
      }
    },
    "billing": {
      "monthly_fee": 123,
      "currency": "EUR"
    },
    "bindings": {
      "call": {
        "bound": true,
        "agent_uuid": "<string>",
        "agent_name": "<string>"
      },
      "sms": {
        "bound": true,
        "agent_uuid": "<string>",
        "agent_name": "<string>"
      },
      "whatsapp": {
        "bound": true,
        "agent_uuid": "<string>",
        "agent_name": "<string>"
      }
    },
    "purchased_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

​
uuid
string<uuid>
required

Body

application/json
​
channel_settings
object

Response

Updated

​
success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

​
data
object

A phone number connected to your workspace. Always returned by inventory and lookup endpoints. The shape is the same for purchased and external (trunk) numbers — fields that don't apply to externals come back as null.