Inativar relacionamento (reversível)

PATCH

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

Marca o relacionamento como inativo (ativo=false). Reversível —
o registro continua na tabela e some das listagens ativas.

{id} na URL = id do registro de relacionamento (linha em
empresas_relacionadas). Não é o id da empresa.

NÃO precisa body — só o :id da URL. Body é ignorado.

Pra reativar, hoje não há endpoint dedicado: ou recria o relacionamento
via POST /empresa-relacionadas, ou abre ticket no time de plataforma.

Requisição

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200OK

application/json

Envelope {ok, data} com o relacionamento já com ativo=false +
updated_by atualizado. Operação idempotente — chamar duas vezes
no mesmo id retorna 200 igual (já estava inativo).

Bodyapplication/json

🟠401Não Autorizado

🟠422Erro de Parâmetro

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/v2/empresa-relacionadas/6/inactivate' \
--header 'api-key: {{api-key}}'

Response Example

200 - Exemplo de Sucesso

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

Modificado em 2026-11-04 02:31:07

Página anterior

Alterar o tipo do relacionamento

Próxima página

Excluir relacionamento (hard-delete)