Atualizar organização

Serviço para atualizar os dados da sua organização: nome, logo, personalização visual (white label) e webhooks. Todos os campos são opcionais; apenas os que você enviar são modificados.

PUT/companychave privadaprk_

Autenticação

Inclua sua chave privada no cabeçalho Authorization.

Authorization: prk_xxx...

Parâmetros de atualização

Nome	Tipo	Obrigatório	Descrição
name	String	Opcional	Nome da organização.
image	String	Opcional	URL do logo da organização.
uxOptions	Object	Opcional	Opções de personalização visual (white label). Apenas as chaves enviadas são atualizadas (veja a nota sobre mesclagem).
uxOptions.primaryColor	String	Condicional	Cor primária da marca em formato hexadecimal (#RGB ou #RRGGBB). Não pode ser branca (#fff / #ffffff).
uxOptions.alternateColor	String	Condicional	Cor secundária da marca em formato hexadecimal (#RGB ou #RRGGBB).
webhooks	Array	Opcional	Lista completa de webhooks. Substitui a configuração existente (mínimo 1, deve incluir o webhook default). Veja Webhooks.

uxOptions é atualizado por campo

Ao enviar uxOptions, apenas as chaves incluídas na requisição são modificadas; o restante da personalização salva é preservado. Por exemplo, enviar somente primaryColor não apaga o alternateColor já configurado.

webhooks substitui a lista completa

Diferentemente de uxOptions, o array webhooks substitui por completo a lista salva. Para manter os webhooks existentes, você deve incluí-los na requisição, e a lista deve sempre conter o webhook com id: "default". Consulte a seção Webhooks para o detalhe de cada campo.

🧪 Exemplos de uso

Atualizar nome, logo e cores

Curl

curl -X PUT 'https://api.auco.ai/v1.5/ext/company' \
  -H 'Authorization: prk_private_key_company' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Mi Empresa",
    "image": "https://miempresa.com/logo.png",
    "uxOptions": {
      "primaryColor": "#021C30",
      "alternateColor": "#A557F2"
    }
  }'

Python

import requests
import json

url = "https://api.auco.ai/v1.5/ext/company"

payload = json.dumps({
  "name": "Mi Empresa",
  "image": "https://miempresa.com/logo.png",
  "uxOptions": {
    "primaryColor": "#021C30",
    "alternateColor": "#A557F2"
  }
})
headers = {
  'Authorization': 'prk_private_key_company',
  'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)

Node.js

const axios = require('axios');

const data = JSON.stringify({
  name: 'Mi Empresa',
  image: 'https://miempresa.com/logo.png',
  uxOptions: {
    primaryColor: '#021C30',
    alternateColor: '#A557F2'
  }
});

const config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: 'https://api.auco.ai/v1.5/ext/company',
  headers: {
    Authorization: 'prk_private_key_company',
    'Content-Type': 'application/json'
  },
  data
};

axios
  .request(config)
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error));

Configurar webhooks

Lembre-se de enviar a lista completa de webhooks, sempre incluindo o default. Para o detalhe de cada campo, consulte a seção Webhooks.

Curl

curl -X PUT 'https://api.auco.ai/v1.5/ext/company' \
  -H 'Authorization: prk_private_key_company' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhooks": [
      {
        "id": "default",
        "description": "Webhook principal",
        "url": "https://miempresa.com/webhooks/auco",
        "header": { "key": "Authorization", "value": "Bearer ..." }
      },
      {
        "id": "billing",
        "description": "Webhook de facturación",
        "url": "https://miempresa.com/webhooks/billing"
      }
    ]
  }'

Python

import requests
import json

url = "https://api.auco.ai/v1.5/ext/company"

payload = json.dumps({
  "webhooks": [
    {
      "id": "default",
      "description": "Webhook principal",
      "url": "https://miempresa.com/webhooks/auco",
      "header": { "key": "Authorization", "value": "Bearer ..." }
    },
    {
      "id": "billing",
      "description": "Webhook de facturación",
      "url": "https://miempresa.com/webhooks/billing"
    }
  ]
})
headers = {
  'Authorization': 'prk_private_key_company',
  'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)

Node.js

const axios = require('axios');

const data = JSON.stringify({
  webhooks: [
    {
      id: 'default',
      description: 'Webhook principal',
      url: 'https://miempresa.com/webhooks/auco',
      header: { key: 'Authorization', value: 'Bearer ...' }
    },
    {
      id: 'billing',
      description: 'Webhook de facturación',
      url: 'https://miempresa.com/webhooks/billing'
    }
  ]
});

const config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: 'https://api.auco.ai/v1.5/ext/company',
  headers: {
    Authorization: 'prk_private_key_company',
    'Content-Type': 'application/json'
  },
  data
};

axios
  .request(config)
  .then((response) => console.log(JSON.stringify(response.data)))
  .catch((error) => console.log(error));

📥 Exemplo de resposta

{
  "response": "OK"
}

⚠️ Respostas de erro

Código	Descrição
400	Dados inválidos: cor fora do formato hexadecimal, primaryColor definida como branca ou webhook default ausente.
401	Autenticação inválida ou ausente.