v1

latestOpenAPI 3.1.02026-07-2678221359.6 KB
Monitoramento

Cria uma nova assinatura de monitoramento

post/monitoring/plans/{plan_id}/subscriptions

Path parameters

plan_idstring uuid required

Identificador do plano

Identificador do plano

Request body

external_idstring nullable

Identificador externo da assinatura

Example request

{
  "external_id": "123456",
  "contact": {
    "name": "João da Silva",
    "phone": "11912345678",
    "email": "user@domain.com"
  },
  "drivers": [
    {
      "name": "João da Silva",
      "document": "123.456.789-00",
      "cnh": "12345678900",
      "cnh_expiration_date": "2022-12-31",
      "first_cnh_date": "2010-01-01",
      "birth_date": "1990-01-01"
    }
  ]
}

Response

Successful Response

idstring uuid required

Identificador da assinatura

external_idstring nullable

Identificador externo

created_atstring date-time required

Data de criação

next_search_atstring date nullable

Data da próxima busca

plan_idstring uuid required

Identificador do plano

is_activeboolean required

Indica se a assinatura está ativa

is_canceledboolean required

Indica se a assinatura foi cancelada