Mettre à jour l'organisation
Service permettant de mettre à jour les données de votre organisation : nom, logo, personnalisation visuelle (marque blanche) et webhooks. Tous les champs sont facultatifs ; seuls ceux que vous envoyez sont modifiés.
/companyclé privéeprk_Authentification
Incluez votre clé privée dans l'en-tête Authorization.
Authorization: prk_xxx...
Paramètres de mise à jour
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
name | String | Facultatif | Nom de l'organisation. |
image | String | Facultatif | URL du logo de l'organisation. |
uxOptions | Object | Facultatif | Options de personnalisation visuelle (marque blanche). Seules les clés envoyées sont mises à jour (voir la note sur la fusion). |
uxOptions.primaryColor | String | Conditionnel | Couleur primaire de la marque au format hexadécimal (#RGB ou #RRGGBB). Ne peut pas être blanche (#fff / #ffffff). |
uxOptions.alternateColor | String | Conditionnel | Couleur secondaire de la marque au format hexadécimal (#RGB ou #RRGGBB). |
webhooks | Array | Facultatif | Liste complète des webhooks. Remplace la configuration existante (minimum 1, doit inclure le webhook default). Voir Webhooks. |
uxOptions est mis à jour champ par champLorsque vous envoyez uxOptions, seules les clés incluses dans la requête sont modifiées ; le reste de la personnalisation enregistrée est conservé. Par exemple, envoyer uniquement primaryColor n'efface pas le alternateColor déjà configuré.
webhooks remplace la liste complèteContrairement à uxOptions, le tableau webhooks remplace entièrement la liste enregistrée. Pour conserver les webhooks existants, vous devez les inclure dans la requête, et la liste doit toujours contenir le webhook avec id: "default". Consultez la section Webhooks pour le détail de chaque champ.
🧪 Exemples d'utilisation
Mettre à jour le nom, le logo et les couleurs
- Curl
- Python
- Node.js
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"
}
}'
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)
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));
Configurer les webhooks
N'oubliez pas d'envoyer la liste complète des webhooks, en incluant toujours le webhook default. Pour le détail de chaque champ, consultez la section Webhooks.
- Curl
- Python
- Node.js
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"
}
]
}'
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)
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));