Create Invite

curl --request POST \
  --url https://api.athenahq.ai/api/v1/invites \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "organization",
  "invite_method": "email",
  "email": "user@example.com",
  "role": "viewer",
  "role_id": "789e0123-e89b-12d3-a456-426614174000",
  "website_id": "123e4567-e89b-12d3-a456-426614174000",
  "group_id": "456e7890-e89b-12d3-a456-426614174000",
  "first_name": "John",
  "last_name": "Doe"
}
'

import requests

url = "https://api.athenahq.ai/api/v1/invites"

payload = {
    "type": "organization",
    "invite_method": "email",
    "email": "user@example.com",
    "role": "viewer",
    "role_id": "789e0123-e89b-12d3-a456-426614174000",
    "website_id": "123e4567-e89b-12d3-a456-426614174000",
    "group_id": "456e7890-e89b-12d3-a456-426614174000",
    "first_name": "John",
    "last_name": "Doe"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'organization',
    invite_method: 'email',
    email: 'user@example.com',
    role: 'viewer',
    role_id: '789e0123-e89b-12d3-a456-426614174000',
    website_id: '123e4567-e89b-12d3-a456-426614174000',
    group_id: '456e7890-e89b-12d3-a456-426614174000',
    first_name: 'John',
    last_name: 'Doe'
  })
};

fetch('https://api.athenahq.ai/api/v1/invites', 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/invites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'organization',
    'invite_method' => 'email',
    'email' => 'user@example.com',
    'role' => 'viewer',
    'role_id' => '789e0123-e89b-12d3-a456-426614174000',
    'website_id' => '123e4567-e89b-12d3-a456-426614174000',
    'group_id' => '456e7890-e89b-12d3-a456-426614174000',
    'first_name' => 'John',
    'last_name' => 'Doe'
  ]),
  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/invites"

	payload := strings.NewReader("{\n  \"type\": \"organization\",\n  \"invite_method\": \"email\",\n  \"email\": \"user@example.com\",\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\",\n  \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"group_id\": \"456e7890-e89b-12d3-a456-426614174000\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.athenahq.ai/api/v1/invites")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"organization\",\n  \"invite_method\": \"email\",\n  \"email\": \"user@example.com\",\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\",\n  \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"group_id\": \"456e7890-e89b-12d3-a456-426614174000\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/invites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"organization\",\n  \"invite_method\": \"email\",\n  \"email\": \"user@example.com\",\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\",\n  \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"group_id\": \"456e7890-e89b-12d3-a456-426614174000\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\"\n}"

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

{
  "success": true,
  "message": "User added to organization",
  "user_id": "abc12345-e89b-12d3-a456-426614174000"
}

POST

api

invites

Create Invite

curl --request POST \
  --url https://api.athenahq.ai/api/v1/invites \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "organization",
  "invite_method": "email",
  "email": "user@example.com",
  "role": "viewer",
  "role_id": "789e0123-e89b-12d3-a456-426614174000",
  "website_id": "123e4567-e89b-12d3-a456-426614174000",
  "group_id": "456e7890-e89b-12d3-a456-426614174000",
  "first_name": "John",
  "last_name": "Doe"
}
'

import requests

url = "https://api.athenahq.ai/api/v1/invites"

payload = {
    "type": "organization",
    "invite_method": "email",
    "email": "user@example.com",
    "role": "viewer",
    "role_id": "789e0123-e89b-12d3-a456-426614174000",
    "website_id": "123e4567-e89b-12d3-a456-426614174000",
    "group_id": "456e7890-e89b-12d3-a456-426614174000",
    "first_name": "John",
    "last_name": "Doe"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'organization',
    invite_method: 'email',
    email: 'user@example.com',
    role: 'viewer',
    role_id: '789e0123-e89b-12d3-a456-426614174000',
    website_id: '123e4567-e89b-12d3-a456-426614174000',
    group_id: '456e7890-e89b-12d3-a456-426614174000',
    first_name: 'John',
    last_name: 'Doe'
  })
};

fetch('https://api.athenahq.ai/api/v1/invites', 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/invites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'organization',
    'invite_method' => 'email',
    'email' => 'user@example.com',
    'role' => 'viewer',
    'role_id' => '789e0123-e89b-12d3-a456-426614174000',
    'website_id' => '123e4567-e89b-12d3-a456-426614174000',
    'group_id' => '456e7890-e89b-12d3-a456-426614174000',
    'first_name' => 'John',
    'last_name' => 'Doe'
  ]),
  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/invites"

	payload := strings.NewReader("{\n  \"type\": \"organization\",\n  \"invite_method\": \"email\",\n  \"email\": \"user@example.com\",\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\",\n  \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"group_id\": \"456e7890-e89b-12d3-a456-426614174000\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.athenahq.ai/api/v1/invites")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"organization\",\n  \"invite_method\": \"email\",\n  \"email\": \"user@example.com\",\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\",\n  \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"group_id\": \"456e7890-e89b-12d3-a456-426614174000\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/invites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"organization\",\n  \"invite_method\": \"email\",\n  \"email\": \"user@example.com\",\n  \"role\": \"viewer\",\n  \"role_id\": \"789e0123-e89b-12d3-a456-426614174000\",\n  \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"group_id\": \"456e7890-e89b-12d3-a456-426614174000\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\"\n}"

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

{
  "success": true,
  "message": "User added to organization",
  "user_id": "abc12345-e89b-12d3-a456-426614174000"
}

Authorizations

x-api-key

string

header

required

API key for authentication. You can create one here.

Body

application/json

Request body for creating an invite

type

enum<string>

required

The type of invite. 'organization' grants org-wide access, 'website' grants access to a single website, 'group' grants access to all websites in a group. Group invites require a global API key.

Available options:

organization,

website,

group

Example:

"organization"

invite_method

enum<string>

required

How to invite the user. 'direct' adds the user to the resource immediately without sending any email — if no account exists for the email, a new user account is created automatically (with emailVerified=false) and the membership is added. 'email' creates a pending invite record and sends an invitation email via Postmark; the user must accept the invite to gain access.

Available options:

direct,

email

Example:

"email"

string<email>

required

Email address of the user to invite

Example:

"user@example.com"

role

enum<string>

The role to assign to the invited user. 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. Defaults to Viewer when neither role nor role_id is given. System role IDs are GUID-shaped sentinels (e.g. 00000000-0000-0000-0000-000000000001), not RFC 4122 UUIDs.

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"

website_id

string<uuid>

Required when type is 'website'. The ID of the website to grant access to

Example:

"123e4567-e89b-12d3-a456-426614174000"

group_id

string<uuid>

Required when type is 'group'. The ID of the group to grant access to. Requires a global API key.

Example:

"456e7890-e89b-12d3-a456-426614174000"

first_name

string

Optional first name of the invited user. Used when creating a new user account for 'direct' invites or populating the invite record for 'email' invites.

Example:

"John"

last_name

string

Optional last name of the invited user. Used when creating a new user account for 'direct' invites or populating the invite record for 'email' invites.

Example:

"Doe"

Response

User added or invitation sent successfully

Response from creating an invite

success

boolean

required

Whether the operation was successful

Example:

true

message

string

required

A message describing the result

Example:

"Invitation sent"

invite_id

string<uuid>

The ID of the created invite (only present for email invites)

Example:

"123e4567-e89b-12d3-a456-426614174000"

user_id

string<uuid>

The ID of the user the invite targets. Present only for direct invites (the user is looked up or created immediately). Never returned for email-method invites to prevent cross-tenant account-existence enumeration.

Example:

"abc12345-e89b-12d3-a456-426614174000"

Overview

Integrations

Core Resources

Analytics

Content & Knowledge

Administration

Create Invite

Authorizations

Body

Response