Phone numbers

Buy a phone number

Buys a phone number for your company and makes it the number your SMS is sent from. This is a purchase and it bills your company.

PUT

https://api.portal.magicdoor.com/company-app/phones/current

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Body

application/json

phoneNumberstringrequired

The number to buy, as listed by the available numbers endpoint. Must be a valid phone number.

example: +12085550100

Response

200 · Your company, with the new number on it.

idstring

Your company.

namestring

The company's name.

emailstring

The company's contact address.

phoneNumberstring

The company's phone number, formatted for reading. This is the number just bought.

languagestring

The company's default language as an ISO 639-1 code.

timeZoneInfostring

The company's timezone, for example America/Boise. Every timestamp in this API is expressed in it.

addressobject

The company's address.

subUrlstring

The company's slug in its MagicDoor URLs.

customDomainstring

The company's own domain, when it has set one up.

publicUrlstring

The company's public site.

onboardedboolean

Whether the company has finished onboarding.

onboardingStatusstring

How far through onboarding it is.

businessModeenum<string>

Whether the company manages rentals or an association.

propertyManagementhoa

featuresenum<string>[]

The optional features switched on for the company.

aicompanyLedgertenantACHNumberLinkingcentralizedPayments

trialAccountUntilstring · date-time

When the trial ends. Absent on a paid account.

closedSincestring · date-time

When the company was closed. Absent while it is open.

createdstring · date-time

When the company was created.

401 · The access token is missing, expired, or not valid.

422 · The number could not be bought — it was taken, the carrier refused it, or the company is not able to buy one.

This buys a number and bills your company

The number is purchased from the carrier as soon as the call succeeds, and it replaces whatever number your company was sending from. There is no confirmation step and no undo through this API.

Buying a number is not enough to start texting on its own. The number also has to clear carrier registration before SMS goes out — check the texting status endpoint until canSend is true.