Sign in

v1

latestOpenAPI 3.1.02026-07-26160119.8 KB
Public API

Atualiza informações de um número virtual móvel.

patch/api/v2/virtual-phone-accounts/{id}

Path parameters

idstring required

Request body

namestring nullable

Nome do número virtual. Utilize para facilitar a gestão dos números virtuais.

costCenterstring nullable

Centro de custo associado ao número virtual.

employeeIdstring nullable

ID do colaborador associado ao número virtual. Envie null para desassociar.

Example request

{
  "name": "Meu Número Virtual",
  "costCenter": "marketing",
  "employeeId": "0140a8c6-3815-45b7-9e60-8e137cad845c",
  "customFields": [
    {
      "label": "Departamento",
      "value": "Vendas"
    }
  ]
}

Response

idstring required

A valid UUID string, in any version.

namestring nullable required

Nome do número virtual. Utilize para facilitar a gestão dos números virtuais.

phoneNumberstring required

Número virtual recém-criado, formatado conforme o padrão internacional E.164.

status'pending' | 'active' | 'blocked' | 'canceled' required
createdAtstring date-time required
canceledAtstring date-time nullable required
cancelReasonstring nullable required
costCenterstring nullable required

Centro de custo associado ao número virtual.

employeeIdstring nullable required

A valid UUID string, in any version.

Example response

{
  "id": "0140a8c6-3815-45b7-9e60-8e137cad845c",
  "name": "Meu Número Virtual",
  "phoneNumber": "+551151231234",
  "costCenter": "marketing",
  "employeeId": "0140a8c6-3815-45b7-9e60-8e137cad845c"
}