Skip to main content
POST
/
v1
/
clients
Create a client
curl --request POST \
  --url https://mgmt-api.voxfra.com/v1/clients \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "ABC Motors",
  "display_name": "ABC Motors - Downtown",
  "type": "automotive",
  "subscription_plan": "Pro",
  "status": "active",
  "contact_person": "Jane Smith",
  "contact_email": "[email protected]",
  "phone_number": "+15551234567"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "ABC Motors Test Client",
    "display_name": "ABC Motors - Downtown",
    "type": "automotive",
    "subscription_plan": "pro",
    "contact_person": "<string>",
    "contact_email": "[email protected]",
    "phone_number": "<string>",
    "joined_at": "2023-11-07T05:31:56Z",
    "last_active_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.voxfra.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Your Voxfra management API key. Passed as a request header.

Format: vox_mgmt_<random>

Body

application/json
​
name
string
required

Display name of the client. Must be unique within your organization.

Required string length: 1 - 200
Example:

"ABC Motors"

​
type
string
required

Free-text business type identifier (e.g., automotive, medical).

Required string length: 1 - 100
Example:

"automotive"

​
subscription_plan
string
required

Subscription plan label. Currently UI-only metadata — the API does not yet enforce a fixed enum so partners can introduce new plan names without a schema migration. A canonical enum will be added once billing is wired in.

Required string length: 1 - 100
Example:

"Pro"

​
display_name
string

Optional public-facing label. Defaults to name when omitted.

Maximum string length: 255
Example:

"ABC Motors - Downtown"

​
status
enum<string>
default:active

Lifecycle state. Defaults to active when omitted.

Available options:
active,
inactive,
trial,
churned,
pending
​
contact_person
string
Maximum string length: 255
​
contact_email
string<email>
Maximum string length: 255
​
phone_number
string

7-15 digits with optional leading +. Whitespace, dashes, and parentheses are stripped before storage.

Example:

"+15551234567"

Response

Client created

​
data
object