Numbers

A number is a WhatsApp number connected to your workspace. List them to find the number_id to send from.

Scopes: numbers:read to read.

Endpoints

List numbersGET /v1/numbers

The number object

A WhatsApp number connected to your workspace.

Attributes

id string · uuid

name string

The name you gave the number in Soosh.

phone string

The number as + and its digits, or empty if Soosh doesn’t know it yet.

display_name string

The name WhatsApp shows for the number.

verified_name string

The business name WhatsApp has verified for the number.

status string

active, or disconnected for a number that can’t send. disconnected covers a number still being set up, or one WhatsApp disconnected.

is_default boolean

Whether messages are sent from this number when none is chosen.

The number object

{
  "id": "0f6d3c1e-5b7a-4c52-9a55-3f6a2d5c8b10",
  "name": "Sales",
  "phone": "+912212345678",
  "display_name": "Blue Lotus Fashion",
  "verified_name": "Blue Lotus Fashion Pvt Ltd",
  "status": "active",
  "is_default": true
}