Skip to Content
API access is available to organizations with a signed BAA. Request API access →
API referenceThe Phone number object

The Phone number object

The clinic phone numbers messages to patients come from, and the team each belongs to.

Attributes

numberstringRequired

The phone number in E.164 format, like +15125550100. Pass it as from when sending.

teamstringRequired

The team the number belongs to, like “Front desk”. Patient replies go to this team’s conversation.

is_defaultbooleanRequired

Whether sends use this number when they don’t pass from.

Endpoints

MethodPathEndpoint
GET/phone-numbersList phone numbers
Last updated on
Retrieve a patient conversationList phone numbers