Docs
Numbersv4

Update a number

PATCH/numbers/{number}

Turn a Blooio SMS or Blooio Voice number's products on and off, or assign its SMS channel to a 10DLC campaign. Turning sms off takes the number off its campaign. iMessage lines can't be changed here. OAuth apps need numbers:manage.

Path parameters

numberRequiredstring

The number in E.164 format, with + URL-encoded as %2B (e.g. %2B15551234567).

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Body parameters

JSON
productsoptionalTelecomProduct[]

The products the number should carry from now on. A product you leave out is turned off and its channel retired; one you add gets a new channel.

campaign_idoptionalstring

Assign the number's SMS channel to this 10DLC campaign (camp_...). The campaign must be provisioned by carriers (mno_provisioned).

Returns

dataoptionalNumber
numberRequiredstring

The number in E.164 format.

productsRequiredNumberProduct[]
statusRequiredstring

The status of the number's most usable channel.

"active""pending_verification""suspended""banned"
channelsRequiredNumberChannel[]

Array of NumberChannel

channel_idRequiredstring

Channel id (ch_...), the from for sends and calls.

typeRequiredstring

Channel type for the product.

"blooio""sms""voice"
statusRequiredstring

The channel's status.

campaign_idoptionalstring | null

SMS only: the 10DLC campaign (camp_...) the number is assigned to.

assignment_statusoptionalstring

SMS only: where the number stands with its campaign. It sends texts once assigned, which needs a campaign carriers have provisioned.

"unassigned""pending""assigned""failed"
inbound_handleroptionalstring

Voice only: who answers the number's inbound calls (see VoiceInboundSettings).

"softphone""agent""api"
created_atRequiredinteger

When the number's first channel was created (epoch ms).

Response codes

200The updated number
400`invalid_number`, `invalid_products`, `invalid_campaign_id`, or `empty_update`.
401Your API key is missing or invalid. Pass it as a bearer token.
403`feature_not_enabled`: Blooio SMS and Blooio Voice aren't enabled on this organization.
404`number_not_found` (including iMessage lines) or `campaign_not_found`.
409`sms_product_required` (a `campaign_id` for a number without `sms`) or `campaign_not_approved`.
422`number_update_rejected`: the carrier refused the change.
502`upstream_unavailable`: the carrier network couldn't be reached. Retry with backoff.
503`telephony_unavailable`: Blooio Voice isn't configured.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X PATCH https://api.blooio.com/v4/numbers/%2B15551234567 \
Body object
Response objectexample
{  "data": {    "number": "+15551234567",    "products": [      "imessage"    ],    "status": "active",    "channels": [      {        "channel_id": "ch_a1b2c3d4",        "type": "blooio",        "status": "active",        "campaign_id": "obj_a1b2c3d4",        "assignment_status": "unassigned",        "inbound_handler": "softphone"      }    ],    "created_at": 0  }}