Vincular empresa ao cliente

POST

/api/v2/cliente-empresas

Cria um vínculo entre o cliente e uma empresa, com tipo.

Regras

id_cliente, id_empresa e tipo_de_relacionamento são obrigatórios.

tipo_de_relacionamento é um value de GET /types.

A empresa precisa existir, não estar excluída e estar ativa.

O mesmo cliente não pode ter duas vezes a mesma empresa.

Já como principal

Com principal: true, o vínculo é criado e vira a principal na mesma operação.
Nesse caso mande id_empresa_esperada com a principal que você leu
(null se o cliente não tinha): se ela mudou no meio do caminho, a resposta é
409 e nada é gravado.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201Criado

application/json

Vínculo criado. principal indica se ele é a principal.

Bodyapplication/json

🟠400Pedido Inválido

🟠401Não Autorizado

🟠404Registo Não Encontrado

🟠409

🟠422Erro de Parâmetro

Request Example

Shell

JavaScript

Java

Swift

cURL

Vincular como secundáriaVincular já como principal

curl --location '/api/v2/cliente-empresas' \
--header 'api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "id_cliente": 4520,
    "id_empresa": 12,
    "tipo_de_relacionamento": "consultor"
}'

Response Example

201 - Vínculo criado

{
    "ok": true,
    "data": {
        "id": 31,
        "id_cliente": 4520,
        "id_empresa": 12,
        "tipo_de_relacionamento": "consultor",
        "ativo": true,
        "principal": false,
        "created_by": 9800,
        "updated_by": null,
        "deleted_at": null
    }
}

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

Página anterior

Listar empresas de um cliente

Próxima página

Trocar a empresa principal

Vincular empresa ao cliente

Regras#

Já como principal#

Requisição

Respostas

Regras

Já como principal