Actualizar grupo
curl --request PATCH \
--url https://api.athenahq.ai/api/v1/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Renamed Group",
"add_website_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"remove_website_ids": [
"987e6543-e21b-12d3-a456-426614174000"
],
"external_id": "acct_9e4c1b8d",
"billing_enabled": true
}
'import requests
url = "https://api.athenahq.ai/api/v1/groups/{group_id}"
payload = {
"name": "Renamed Group",
"add_website_ids": ["123e4567-e89b-12d3-a456-426614174000"],
"remove_website_ids": ["987e6543-e21b-12d3-a456-426614174000"],
"external_id": "acct_9e4c1b8d",
"billing_enabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Renamed Group',
add_website_ids: ['123e4567-e89b-12d3-a456-426614174000'],
remove_website_ids: ['987e6543-e21b-12d3-a456-426614174000'],
external_id: 'acct_9e4c1b8d',
billing_enabled: true
})
};
fetch('https://api.athenahq.ai/api/v1/groups/{group_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.athenahq.ai/api/v1/groups/{group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Renamed Group',
'add_website_ids' => [
'123e4567-e89b-12d3-a456-426614174000'
],
'remove_website_ids' => [
'987e6543-e21b-12d3-a456-426614174000'
],
'external_id' => 'acct_9e4c1b8d',
'billing_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/groups/{group_id}"
payload := strings.NewReader("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.athenahq.ai/api/v1/groups/{group_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/groups/{group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Enterprise Clients",
"orgId": "987e6543-e21b-12d3-a456-426614174000",
"billingEnabled": false,
"createdAt": "2024-06-15T10:30:00.000Z",
"websites": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"websiteUrl": "example.com",
"websiteName": "My Awesome Blog",
"externalId": "ws_a7f3b2c9"
}
],
"externalId": "acct_9e4c1b8d"
}
}Grupos
Actualizar grupo
Actualiza el nombre de un grupo, añade o elimina sitios web y, solo para socios, establece o borra la vinculación external_id. Indica al menos un campo. Requiere una clave global. Las integraciones de socios pueden pasar external_id como una cadena no vacía para establecer o sustituir la vinculación, o null para borrarla. La respuesta incluye externalId en el grupo y en cada objeto de websites (null si no hay vinculación).
PATCH
/
api
/
v1
/
groups
/
{group_id}
Actualizar grupo
curl --request PATCH \
--url https://api.athenahq.ai/api/v1/groups/{group_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Renamed Group",
"add_website_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"remove_website_ids": [
"987e6543-e21b-12d3-a456-426614174000"
],
"external_id": "acct_9e4c1b8d",
"billing_enabled": true
}
'import requests
url = "https://api.athenahq.ai/api/v1/groups/{group_id}"
payload = {
"name": "Renamed Group",
"add_website_ids": ["123e4567-e89b-12d3-a456-426614174000"],
"remove_website_ids": ["987e6543-e21b-12d3-a456-426614174000"],
"external_id": "acct_9e4c1b8d",
"billing_enabled": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Renamed Group',
add_website_ids: ['123e4567-e89b-12d3-a456-426614174000'],
remove_website_ids: ['987e6543-e21b-12d3-a456-426614174000'],
external_id: 'acct_9e4c1b8d',
billing_enabled: true
})
};
fetch('https://api.athenahq.ai/api/v1/groups/{group_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.athenahq.ai/api/v1/groups/{group_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Renamed Group',
'add_website_ids' => [
'123e4567-e89b-12d3-a456-426614174000'
],
'remove_website_ids' => [
'987e6543-e21b-12d3-a456-426614174000'
],
'external_id' => 'acct_9e4c1b8d',
'billing_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/groups/{group_id}"
payload := strings.NewReader("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.athenahq.ai/api/v1/groups/{group_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/groups/{group_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Renamed Group\",\n \"add_website_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\"\n ],\n \"remove_website_ids\": [\n \"987e6543-e21b-12d3-a456-426614174000\"\n ],\n \"external_id\": \"acct_9e4c1b8d\",\n \"billing_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Enterprise Clients",
"orgId": "987e6543-e21b-12d3-a456-426614174000",
"billingEnabled": false,
"createdAt": "2024-06-15T10:30:00.000Z",
"websites": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"websiteUrl": "example.com",
"websiteName": "My Awesome Blog",
"externalId": "ws_a7f3b2c9"
}
],
"externalId": "acct_9e4c1b8d"
}
}Parámetros de ruta
Identificador único del grupo
Cuerpo
application/json
Cuerpo de la solicitud para actualizar un grupo. Debe indicarse al menos un campo.
Nuevo nombre del grupo.
Minimum string length:
1Ejemplo:
"Renamed Group"
ID de sitios web que se añadirán al grupo. Deben pertenecer a tu organización. Los que ya están en el grupo se ignoran sin error.
Minimum array length:
1Ejemplo:
["123e4567-e89b-12d3-a456-426614174000"]
ID de sitios web que se eliminarán del grupo. Los ID que no pertenecen al grupo se ignoran sin error.
Minimum array length:
1Ejemplo:
["987e6543-e21b-12d3-a456-426614174000"]
Solo socios. Identificador del socio que se asociará al grupo. Pasa una cadena no vacía para establecer o sustituir la vinculación, o null para borrarla. Solo se admite con una clave de una organización marcada como socio. Los clientes directos reciben 403 Forbidden. Debe ser único por tipo de recurso en tu organización; un valor ya usado por otro grupo devuelve 409 con el recurso existente en la respuesta.
Minimum string length:
1Ejemplo:
"acct_9e4c1b8d"
Usa true para habilitar la facturación del grupo. Aprovisiona una entidad en el proveedor de facturación, requisito para asignar créditos al grupo (operación exclusiva de socios). Es idempotente: se puede llamar con seguridad si la entidad nunca se creó o el aprovisionamiento inicial falló sin avisar. Usa false para desactivar el indicador sin destruir el estado de facturación existente; se conservan saldos e historial de uso. Devuelve 502 si el proveedor no puede aprovisionar la entidad; no se modifica la base de datos y puedes reintentar desde cero.
Ejemplo:
true
Respuesta
Grupo actualizado correctamente. Las respuestas a socios incluyen externalId (cadena o null); las respuestas a clientes directos omiten por completo el campo.
Un grupo de sitios web de tu organización
Show child attributes
Show child attributes
¿Esta página le ayudó?