Skip to main content
PATCH
/
entities
/
{id}
/
attributes
Atualizar atributos da entidade
curl --request PATCH \
  --url http://api.gu1.ai/entities/{id}/attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": {},
  "mode": "<string>",
  "skipRulesExecution": true
}
'

​
Visão geral

Atualiza somente attributes sem alterar outros campos do perfil. Dois modos:
ModoComportamento
merge (padrão)Merge superficial: chaves enviadas sobrescrevem ou criam valores; chaves não enviadas são mantidas
replaceSubstituição total: o objeto attributes do body vira o mapa completo ({} limpa tudo)
Os atributos são armazenados exatamente como enviados — objetos aninhados atuam como categorias e são retornados como enviados, igual a Atualizar entidade: 
{
  "mode": "merge",
  "attributes": {
    "contact": { "phone": "+54..." },
    "otro_grupo": { "branchCode": "AR-01" }
  }
}
O merge é raso no primeiro nível: enviar um objeto de categoria (ex.: contact) substitui toda essa categoria. Chaves internas não incluídas são descartadas. Use replace para reescrever tudo.
Se a matriz atribuída inclui trigger entity_updated, as regras rodam após o patch (respeita skipRulesExecution e watchFields). Webhook entity.updated é emitido com changes.attributes.

​
Endpoint

PATCH http://api.gu1.ai/entities/{id}/attributes

​
Autenticação

Requer entities:edit (fallback legacy: entities:write). 
Authorization: Bearer YOUR_API_KEY

​
Parâmetros de rota

​
id
string
required
UUID da entidade.

​
Body

​
attributes
object
required
Mapa de atributos. Armazenado exatamente como enviado: valores escalares/array na raiz ficam sem categoria; objetos aninhados atuam como categorias.
​
mode
string
default:"merge"
merge — patch aditivo (padrão). replace — substituição completa.
​
skipRulesExecution
boolean
Com true, omite execução de matrizes de risco após a atualização.

​
Resposta

CampoTipoDescrição
data.entityIdstringUUID da entidade
data.modestringmerge ou replace aplicado
data.attributesobjectAtributos finais
data.updatedAtstringTimestamp ISO 8601
data.rulesExecutionSummaryobjectResumo da execução de regras

​
Exemplos

​
Merge (padrão)

curl -X PATCH "https://api.gu1.ai/entities/{id}/attributes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "attributes": {
      "contact": { "phone": "+54115550000" }
    }
  }'
Chaves existentes não enviadas permanecem inalteradas.

​
Substituição total

curl -X PATCH "https://api.gu1.ai/entities/{id}/attributes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "replace",
    "attributes": {
      "commercial": { "mcc": "5411" }
    }
  }'
Chaves que existiam e não estão em attributes são removidas.

​
Erros

HTTPCódigoQuando
404ENTITY_NOT_FOUNDEntidade inexistente ou outra org
400validationBody inválido