Skip to content

Company

Management of company (tenant) settings. Requires manager role or above.

Endpoints

MethodEndpointDescriptionMinimum Role
GET/api/v1/companyGet company datamanager
PUT/api/v1/companyUpdate companymanager

Get Company

Returns the company settings for the current tenant.

GET /api/v1/company

Request Example

bash
curl -X GET https://voki.avanter.com.br/api/v1/company \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter"

Success Response (200)

json
{
  "data": {
    "id": "d4e5f6a7-b8c9-0123-defg-456789012345",
    "name": "Avanter Aliado Tecnológico Ltda",
    "slug": "avanter",
    "document": "12.345.678/0001-90",
    "document_type": "cnpj",
    "email": "contato@avanter.com.br",
    "phone": "+5511999999999",
    "logo_url": null,
    "primary_color": "#6366f1",
    "max_concurrent_calls": 10,
    "recording_enabled": true,
    "transcription_enabled": true,
    "mfa_required": false,
    "plan": "professional",
    "stripe_customer_id": "cus_xxx",
    "stripe_subscription_id": "sub_xxx",
    "inserted_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-02-15T10:00:00Z"
  }
}

Update Company

Updates the company settings.

PUT /api/v1/company

Request Body

FieldTypeRequiredDescription
namestringNoCompany name
emailstringNoContact email
phonestringNoPhone number
logo_urlstringNoLogo URL
primary_colorstringNoPrimary color (hex)
recording_enabledbooleanNoEnable call recording
transcription_enabledbooleanNoEnable AI transcription
mfa_requiredbooleanNoRequire MFA for all users

Request Example

bash
curl -X PUT https://voki.avanter.com.br/api/v1/company \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter" \
  -H "Content-Type: application/json" \
  -d '{
    "company": {
      "name": "Avanter Aliado Tecnológico Ltda",
      "recording_enabled": true,
      "mfa_required": true
    }
  }'

Success Response (200)

json
{
  "data": {
    "id": "d4e5f6a7-b8c9-0123-defg-456789012345",
    "name": "Avanter Aliado Tecnológico Ltda",
    "slug": "avanter",
    "document": "12.345.678/0001-90",
    "document_type": "cnpj",
    "email": "contato@avanter.com.br",
    "phone": "+5511999999999",
    "logo_url": null,
    "primary_color": "#6366f1",
    "max_concurrent_calls": 10,
    "recording_enabled": true,
    "transcription_enabled": true,
    "mfa_required": true,
    "plan": "professional",
    "stripe_customer_id": "cus_xxx",
    "stripe_subscription_id": "sub_xxx",
    "inserted_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-02-18T11:30:00Z"
  }
}

Errors

CodeDescription
422Invalid data
403Permission denied

Documentação da API Voki v4.0