Update Group Member Role

curl --request PATCH \
  --url https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "role": "viewer",
  "role_id": "789e0123-e89b-12d3-a456-426614174000"
}
'

import requests

url = "https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_id}"

payload = {
    "role": "viewer",
    "role_id": "789e0123-e89b-12d3-a456-426614174000"
}
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({role: 'viewer', role_id: '789e0123-e89b-12d3-a456-426614174000'})
};

fetch('https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_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}/members/{user_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([
    'role' => 'viewer',
    'role_id' => '789e0123-e89b-12d3-a456-426614174000'
  ]),
  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}/members/{user_id}"

	payload := strings.NewReader("{\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\"\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}/members/{user_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_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  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "member": {
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "viewer",
    "role_id": "<string>"
  }
}

Members

Update Group Member Role

Updates the role of a user who was explicitly added to a group (a group_members row, shown as access_type: "group" by GET /api/v1/groups/{group_id}/members). Accepts either the coarse role (admin/viewer) or a role_id: a system role or one of your organization’s custom roles (see GET /api/v1/roles). Provide exactly one. Requires a global API key.

Organization members are out of scope: their access to every group in the org comes from their organization role, so a group-level write would not change what they can do. Targeting one returns 409; use PATCH /api/v1/organizations/members/{user_id} instead. The API key’s own user cannot be modified. There is no last-admin restriction at group scope: a group’s only admin can be demoted, since organization admins retain admin access to every group in the organization.

Roles other than admin and viewer are honored for access but are not yet rendered in the dashboard. A role_id such as Editor or Billing Manager grants that role’s real permissions on every website in the group, but the dashboard’s group member list currently collapses any non-admin role to “Viewer”. Prefer admin / viewer at group scope when a customer administrator also needs to see the assigned role.

PATCH

api

groups

{group_id}

members

{user_id}

Update Group Member Role

curl --request PATCH \
  --url https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "role": "viewer",
  "role_id": "789e0123-e89b-12d3-a456-426614174000"
}
'

import requests

url = "https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_id}"

payload = {
    "role": "viewer",
    "role_id": "789e0123-e89b-12d3-a456-426614174000"
}
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({role: 'viewer', role_id: '789e0123-e89b-12d3-a456-426614174000'})
};

fetch('https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_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}/members/{user_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([
    'role' => 'viewer',
    'role_id' => '789e0123-e89b-12d3-a456-426614174000'
  ]),
  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}/members/{user_id}"

	payload := strings.NewReader("{\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\"\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}/members/{user_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/groups/{group_id}/members/{user_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  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "member": {
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "role": "viewer",
    "role_id": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

API key for authentication. You can create one here.

Path Parameters

group_id

string<uuid>

required

The unique identifier of the group

user_id

string<uuid>

required

The unique identifier of the target user

Body

application/json

Request body for updating a group member's role. Provide exactly one of role or role_id.

role

enum<string>

Coarse role to assign. Mutually exclusive with role_id.

Available options:

admin,

viewer

Example:

"viewer"

role_id

string

Assign any role by ID: a system role or one of your organization's custom roles (see GET /api/v1/roles). Mutually exclusive with role. Returns 404 if the role does not exist or belongs to another organization. System role IDs are GUID-shaped sentinels (e.g. 00000000-0000-0000-0000-000000000001), not RFC 4122 UUIDs. At group scope, roles other than Admin and Viewer are honored for access but are displayed as "Viewer" in the dashboard's group member list.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example:

"789e0123-e89b-12d3-a456-426614174000"

Response

Member role updated successfully

success

boolean

required

Example:

true

member

object

required

Show child attributes

Overview

Integrations

Core Resources

Analytics

Content & Knowledge

Administration

Update Group Member Role

Authorizations

Path Parameters

Body

Response