Rent a Number

Rents a new number in Routee.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

stringrequired

The phone number. Format with a '+' and country code e.g., +3069485xxxxx (E.164 format).

string

Defines the callback URL that will receive the inbound messages.

object

Defines the Voice inbound strategy

string

Defines the dialplan URL

string

A valid SIP address to forward the inbound call

string

A valid phone number in E.164 Format to forward the inbound call

string

Defines the callback URL that will receive the inbound Voice messages.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/routee/latest/actions/rent-a-number" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "msisdn": ""
}'

{
  "success": true,
  "data": [
    {
      "activationCosts": {
        "currency": "string",
        "price": 1
      },
      "chargeInterval": 1,
      "country": "string",
      "inboundCosts[]": {
        "currency": "string",
        "price": 1,
        "service": "string"
      },
      "inboundSmsCallbackUrl": "https://example.com",
      "monthlyCosts": {
        "currency": "string",
        "price": 1
      },
      "msisdn": "string",
      "nextRenewal": "string",
      "services[]": [
        "string"
      ],
      "tollFree": true,
      "trackingId": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.