TheDocumentation Index
Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt
Use this file to discover all available pages before exploring further.
Phone entity represents phone numbers in the Well system. It can be associated with people, companies, and workspaces, and includes verification status, primary designation, and contextual labels.
Table structure
Table name:phones
Main fields
| Name | Type | Required | Constraints | Allowed Values | Description | Example |
|---|---|---|---|---|---|---|
id | string, UUID, π system | β | Unique identifier (read-only) | β | Unique ID | βphone-uuid-123β |
number | string | β Yes | E.164 formatted number | E.164 format (+33123456789) | Phone number | β+33123456789β |
is_primary | boolean | βͺ No | default: true, only valid when in relationship with a Person or Company | true, false | Marks preferred phone | true |
is_verified | boolean | βͺ No | default: false, only valid when in relationship with a Person or Company | true, false | Verification flag for 2FA setup | true |
label | string (50 char) | βͺ No | max 50 chars, only valid when in relationship with a Person or Company | work, mobile, home, other | Tag for extra context when having multiple phones | βmobileβ |
created_at | string (ISO 8601) π system | β | auto timestamp | β | Creation timestamp | β2023-01-01T12:00:00Zβ |
updated_at | string (ISO 8601) π system | β | auto timestamp | β | Last update timestamp | β2023-01-01T12:00:00Zβ |
deleted_at | string | null π system | β | nullable ISO 8601 | β | Deletion timestamp (soft delete) | β2024-01-01T12:00:00Zβ |
Relations
Many-to-Many relations
- People: Can be associated with multiple people
- Companies: Can be associated with multiple companies
- Workspaces: Can be associated with multiple workspaces