Empresa - Atualização de campos do registro.

Método e URL

PATCH https://api.agilize.app/crm/company/company/{_id}

Autenticação

Envie a chave de API no cabeçalho da requisição.

Accept: application/json
x-api-key: SUA_CHAVE_API

Parâmetros

Nome	Origem	Obrigatório	Tipo	Descrição
x-api-key	header	Sim	string	Chave da API de integração gerada em seu painel gerencial.
_id	path	Sim	integer	ID of Empresa to update
content-type	header	Sim	string	application/json

Corpo da requisição

Obrigatório: Sim
Content-Type: application/json

Campos do corpo

Campo	Tipo	Obrigatório
name	string	Não
automations	string	Não
contacts	object	Não
leads	string	Não
phones	object	Não
emails	object	Não
socials	object	Não
import	string	Não
website	string	Não
note	string	Não
user	string	Não
system_source	string	Não
createdBy	string	Não
tags	string	Não
createdAt	string (date-time)	Não
_	object	Não
fidx1	string	Não
fidx2	string	Não
fidx3	string	Não
transmissionList	string	Não

Estruturas internas

contacts

[
  {
    "role": "string"
  }
]

phones

[
  {
    "phone": "string",
    "itemType": "number"
  }
]

emails

[
  {
    "email": "string",
    "itemType": "number"
  }
]

socials

[
  {
    "link": "string",
    "itemType": "number"
  }
]

Exemplo básico:

{
  "name": "Empresa de teste",
  "emails": [
    {
      "email": "empresa.teste@exemplo.com"
    }
  ],
  "phones": [
    {
      "phone": "+5511988887777"
    }
  ]
}

Respostas

Status	Descrição	Conteúdo
200	success	application/json
401	not authenticated
404	not found
500	general error

Testar requisição

Preencha os parâmetros, informe a chave no cabeçalho x-api-key e envie a requisição diretamente pelo navegador.

Carregando teste interativo do endpoint...

PATCH`/crm/company/company/{_id}`