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",
  "contact_person": "Jane Smith",
  "contact_email": "jane@abcmotors.com",
  "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",
    "status": "active",
    "subscription_plan": "pro",
    "contact_person": "<string>",
    "contact_email": "jsmith@example.com",
    "phone_number": "<string>",
    "joined_at": "2023-11-07T05:31:56Z",
    "last_active_at": "2023-11-07T05:31:56Z"
  }
}

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
Example:

"ABC Motors"

​
type
string
required
Example:

"automotive"

​
subscription_plan
enum<string>
required
Available options:
starter,
pro,
enterprise
​
display_name
string
Example:

"ABC Motors - Downtown"

​
contact_person
string
​
contact_email
string<email>
​
phone_number
string
Example:

"+15551234567"

Response

Client created

​
data
object