Update Transport Operator - Documentação DEVMOB

curl --request PATCH \ --url https://api.example.com/api/v1/ops/transport-operators/{transportOperatorId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "legalName": "<string>", "tradeName": "<string>", "blockedReason": "<string>" } '

{ "transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "legalName": "<string>", "tradeName": "<string>", "document": "<string>", "blockedReason": "<string>", "approvedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "approvedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

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

Path Parameters

transportOperatorId

string<uuid>

required

Transport operator identifier

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Update transport operator payload

legalName

string

Legal name

tradeName

string | null

Trade name

regularityStatus

enum<string>

Regularity status

Available options:

PENDING_REVIEW,

REGULAR,

IRREGULAR

status

enum<string>

Status

Available options:

PENDING_APPROVAL,

ACTIVE,

INACTIVE,

BLOCKED,

REJECTED

blockedReason

string | null

Blocked reason

Response

Permissionário autorizado a operar transporte dentro de uma cooperativa

transportOperatorId

string<uuid>

required

Identificador único

cooperativeId

string<uuid>

required

Cooperativa responsável pelo permissionário

legalName

string

required

Nome legal do permissionário

tradeName

string | null

required

Nome fantasia, quando existir

document

string

required

Documento normalizado

documentType

enum<string>

required

Tipo do documento

Available options:

CPF,

CNPJ

status

enum<string>

required

Status cadastral e operacional

Available options:

PENDING_APPROVAL,

ACTIVE,

INACTIVE,

BLOCKED,

REJECTED

regularityStatus

enum<string>

required

Situação de regularidade para operação

Available options:

PENDING_REVIEW,

REGULAR,

IRREGULAR

blockedReason

string | null

required

Motivo do bloqueio, quando aplicável

approvedBy

string<uuid> | null

required

Usuário que aprovou o permissionário

approvedAt

string<date-time> | null

required

Data de aprovação

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização

deletedBy

string<uuid> | null

required

Usuário que removeu o registro, quando aplicável

deletedAt

string<date-time> | null

required

Data de remoção