Criar relacionamento entre duas empresas

POST

/api/v2/empresa-relacionadas

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

Cria um relacionamento direcional principal → relacionada com um tipo.

⚠️ Sobre os IDs do body

id_empresa_principal e id_empresa_relacionada são IDs de empresa
(linha em empresa.id) — descobre via GET /api/v2/crm/data/filter
com "table":"empresa". Não confundir com id do relacionamento.

Invariantes (rejeitam com 4xx)

Self-relation proibido: id_empresa_principal != id_empresa_relacionada.

Sem duplicar: mesma tripla {principal, relacionada, tipo} já existente → erro.

Empresas devem existir, estar ativo=true e não soft-deletadas (deleted_at IS NULL).

tipo_de_relacionamento deve estar na lista de GET /types.

Auditoria

Cria também trilha em empresas_relacionadas_audit (registro antes/depois + id_usuario).

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonObrigatório

Examples

ACME (12) tem filial 34ACME (12) é fornecida por 34

{
    "id_empresa_principal": 12,
    "id_empresa_relacionada": 34,
    "tipo_de_relacionamento": "filial"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

ACME (12) tem filial 34ACME (12) é fornecida por 34

curl --location '/api/v2/empresa-relacionadas' \
--header 'api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "id_empresa_principal": 12,
    "id_empresa_relacionada": 34,
    "tipo_de_relacionamento": "filial"
}'

Respostas

🟢201Criado

application/json

Envelope {ok, data} com o relacionamento criado. id é o id do registro
(use em PATCH/DELETE). ativo nasce true. created_by vem do usuário
autenticado da api-key. updated_by começa null.

Bodyapplication/json

Exemplo

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

🟠400Pedido Inválido

🟠401Não Autorizado

🟠422Erro de Parâmetro

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

Página anterior

Listar relacionamentos de uma empresa (ambas as direções)

Próxima página

Alterar o tipo do relacionamento