Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
reason
enum<string>
required

Motivo do cancelamento da linha.

Available options:
employee-fired,
unnecessary,
no-coverage,
technical-problems,
whatsapp-problems,
whatsapp-blocked,
sim-card-swap,
other
Example:

"unnecessary"

type
enum<string>
default:immediate

Quando a linha é cancelada. "immediate" cancela na hora. "scheduled" mantém a linha funcionando até o fim do ciclo de faturamento atual e a cancela nessa data. Só uma linha ativa pode ter o cancelamento agendado. Nos dois casos, o mês corrente é cobrado.

Available options:
immediate,
scheduled
Example:

"scheduled"

reasonDetail
string

Detalhamento do motivo. Obrigatório quando reason for "other". Máximo de 248 caracteres.

Required string length: 1 - 248
Example:

"Cliente encerrou as atividades da filial"

Response

id
string
required

Identificador único da linha.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

companyId
string
required

ID da empresa dona da linha.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

productType
enum<string>
required

Tipo do produto da linha. Novos tipos poderão ser adicionados sem mudança de versão — cheque este campo ao consumir.

Available options:
mobile,
mobile-did,
global
Example:

"mobile"

simType
enum<string>
required

Tipo de chip da linha: "physical" (chip físico), "esim" (eSIM) ou "virtual" (linhas de número virtual, como as do tipo mobile-did). Novos valores poderão ser adicionados sem mudança de versão — cheque este campo ao consumir.

Available options:
physical,
esim,
virtual
Example:

"esim"

iccid
string | null
required

ICCID do chip (físico ou eSIM) da linha, com 20 dígitos incluindo o dígito verificador — o mesmo número que o aparelho informa ao MDM. Nulo enquanto a linha ainda não tem chip associado (por exemplo, um chip físico ainda não ativado ou um eSIM ainda não provisionado) e sempre nulo em linhas de número virtual (simType igual a "virtual").

Example:

"89550000000001231230"

name
string | null
required

Nome da linha, definido pelo cliente para facilitar a gestão.

Example:

"Maria - Vendas"

phoneNumber
string | null
required

Número que o cliente reconhece como sendo dessa linha, formatado conforme o padrão internacional E.164. Nulo enquanto a linha ainda não tem número definido.

Example:

"+5541999887766"

redirectPhoneNumber
string | null
required

Número para o qual as chamadas recebidas nesta linha são redirecionadas. Nulo quando a linha não tem redirecionamento configurado.

Example:

"+5541999887766"

redirectExpiresAt
string<date-time> | null
required

Data e hora em que o redirecionamento configurado para esta linha expira. Nulo quando não há expiração definida ou quando a linha não tem redirecionamento configurado.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-09-01T00:00:00Z"

status
enum<string>
required

Status público da linha. "available" indica uma linha disponível para uso, com a cobrança iniciando após a ativação. Novos valores podem ser adicionados a este enum sem uma mudança de versão da API — trate qualquer valor não reconhecido como "blocked".

Available options:
pending,
available,
active,
partial-block,
blocked,
canceled
Example:

"active"

dataBalanceGB
number | null
required

Saldo de dados restante, em GB. Nulo quando a linha não está ativa ou o valor ainda não pôde ser medido. Nunca use 0 como indicador de ausência de valor: um 0 real significa linha ativa, medida, com dados esgotados.

Example:

32.5

dataBalanceUpdatedAt
string<date-time> | null
required

Data e hora da última atualização do saldo de dados. Nulo quando não há saldo medido.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-08-03T14:00:00Z"

activatedAt
string<date-time> | null
required

Data e hora de ativação da linha. Nulo enquanto a linha ainda não foi ativada.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-05-10T13:22:04Z"

canceledAt
string<date-time> | null
required

Data e hora de cancelamento da linha. Nulo enquanto a linha não foi cancelada.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-07-15T09:00:00Z"

cancellationScheduledFor
string<date-time> | null
required

Data e hora em que a linha será cancelada, quando o cancelamento foi agendado para o fim do ciclo de faturamento. Nulo quando não há cancelamento agendado.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-09-01T02:59:59Z"

createdAt
string<date-time>
required

Data e hora de criação da linha.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-05-08T11:02:33Z"

costCenter
object | null
required

Centro de custo da linha; detalhes em GET /cost-centers/{id}. Nulo quando a linha não tem centro de custo definido.

employee
object | null
required

Colaborador associado à linha; detalhes em GET /employees/{id}. Nulo quando a linha não tem colaborador associado.

customFields
object[]
required

Campos customizados associados à linha.

plan
object | null
required

Plano contratado pela linha. Toda linha tem um plano; o nulo é excepcional, mas trate o campo como opcional mesmo assim.