Inativar relacionamento (reversível)

PATCH

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

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

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

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff --request PATCH 'https://api-{tenant}.digitalk.com.br/api/v2/empresa-relacionadas/6/inactivate' \
--header 'api-key: API_TOKEN (disponível no database da plataforma)'

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

Exemplo

{
    "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
    }
}

🟠401Não Autorizado

🟠422Erro de Parâmetro

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

Página anterior

Alterar o tipo do relacionamento

Próxima página

Excluir relacionamento (hard-delete)