Alterar o tipo do relacionamento

PATCH

/api/v2/empresa-relacionadas/{id}/type

Última modificação:2026-05-28 20:05:32

Altera o tipo_de_relacionamento de um relacionamento existente.

{id} na URL = id do registro de relacionamento (linha em
empresas_relacionadas), retornado como id em GET /by-empresa/{idEmpresa}.
Não é o id da empresa.

Body obrigatório com tipo_de_relacionamento.

Tipos aceitos: ver GET /api/v2/empresa-relacionadas/types.

Requisição

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonObrigatório

Examples

Mudar pra "subsidiaria"Mudar pra "fornecedor"

{
    "tipo_de_relacionamento": "subsidiaria"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Mudar pra "subsidiaria"Mudar pra "fornecedor"

curl --location --request PATCH '/api/v2/empresa-relacionadas/6/type' \
--header 'api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "tipo_de_relacionamento": "subsidiaria"
}'

Respostas

🟢200OK

application/json

Envelope {ok, data} com o relacionamento já com o novo tipo + updated_by atualizado.

Bodyapplication/json

Exemplo

{
    "ok": true,
    "data": {
        "id": 9,
        "id_empresa_principal": 4,
        "id_empresa_relacionada": 2,
        "tipo_de_relacionamento": "filial",
        "ativo": true,
        "created_by": 9800,
        "updated_by": 9800
    }
}

🟠401Não Autorizado

🟠422Erro de Parâmetro

Modificado em 2026-05-28 20:05:32

Página anterior

Criar relacionamento entre duas empresas

Próxima página

Inativar relacionamento (reversível)