Events
Add an event person
Adds one accessible donor or staff member with a role. Exactly one donor_id/user_id is required, and duplicate identity/role combinations are rejected. Requires the event management capability; all referenced records must belong to this event and organization.
POST
/
admin
/
events
/
{eventId}
/
people
Add an event person
curl --request POST \
--url https://api.gratona.com/v1/admin/events/{eventId}/people \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role": "host",
"donor_id": 42,
"user_id": 42,
"display_name_override": "Jane Doe",
"public_visibility": false,
"sort_order": 0
}
'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/people"
payload = {
"role": "host",
"donor_id": 42,
"user_id": 42,
"display_name_override": "Jane Doe",
"public_visibility": False,
"sort_order": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
role: 'host',
donor_id: 42,
user_id: 42,
display_name_override: 'Jane Doe',
public_visibility: false,
sort_order: 0
})
};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/people', 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.gratona.com/v1/admin/events/{eventId}/people",
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([
'role' => 'host',
'donor_id' => 42,
'user_id' => 42,
'display_name_override' => 'Jane Doe',
'public_visibility' => false,
'sort_order' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.gratona.com/v1/admin/events/{eventId}/people"
payload := strings.NewReader("{\n \"role\": \"host\",\n \"donor_id\": 42,\n \"user_id\": 42,\n \"display_name_override\": \"Jane Doe\",\n \"public_visibility\": false,\n \"sort_order\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.gratona.com/v1/admin/events/{eventId}/people")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"role\": \"host\",\n \"donor_id\": 42,\n \"user_id\": 42,\n \"display_name_override\": \"Jane Doe\",\n \"public_visibility\": false,\n \"sort_order\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/people")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"role\": \"host\",\n \"donor_id\": 42,\n \"user_id\": 42,\n \"display_name_override\": \"Jane Doe\",\n \"public_visibility\": false,\n \"sort_order\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"donor_id": 42,
"user_id": 42,
"role": "host",
"display_name_override": "Jane Doe",
"public_visibility": false,
"sort_order": 0,
"id": 42,
"display_name": "Example"
}
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Record ID in the authenticated organization.
Example:
42
Body
application/json
Event role, unique for this identity within the event.
Available options:
host, co_host, worship_leader, speaker, volunteer, table_host, internal_owner Example:
"host"
Existing donor identity; choose donor_id or user_id, exactly one.
Example:
42
Existing staff identity in the organization; choose exactly one identity.
Example:
42
Optional displayed name override.
Maximum string length:
255Example:
"Jane Doe"
Whether the person appears on the public event page.
Example:
false
Display order.
Required range:
x >= 0Example:
0
Response
Add an event person completed.
Show child attributes
Show child attributes
⌘I
Add an event person
curl --request POST \
--url https://api.gratona.com/v1/admin/events/{eventId}/people \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"role": "host",
"donor_id": 42,
"user_id": 42,
"display_name_override": "Jane Doe",
"public_visibility": false,
"sort_order": 0
}
'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/people"
payload = {
"role": "host",
"donor_id": 42,
"user_id": 42,
"display_name_override": "Jane Doe",
"public_visibility": False,
"sort_order": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
role: 'host',
donor_id: 42,
user_id: 42,
display_name_override: 'Jane Doe',
public_visibility: false,
sort_order: 0
})
};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/people', 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.gratona.com/v1/admin/events/{eventId}/people",
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([
'role' => 'host',
'donor_id' => 42,
'user_id' => 42,
'display_name_override' => 'Jane Doe',
'public_visibility' => false,
'sort_order' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.gratona.com/v1/admin/events/{eventId}/people"
payload := strings.NewReader("{\n \"role\": \"host\",\n \"donor_id\": 42,\n \"user_id\": 42,\n \"display_name_override\": \"Jane Doe\",\n \"public_visibility\": false,\n \"sort_order\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.gratona.com/v1/admin/events/{eventId}/people")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"role\": \"host\",\n \"donor_id\": 42,\n \"user_id\": 42,\n \"display_name_override\": \"Jane Doe\",\n \"public_visibility\": false,\n \"sort_order\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/people")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"role\": \"host\",\n \"donor_id\": 42,\n \"user_id\": 42,\n \"display_name_override\": \"Jane Doe\",\n \"public_visibility\": false,\n \"sort_order\": 0\n}"
response = http.request(request)
puts response.read_body{
"data": {
"donor_id": 42,
"user_id": 42,
"role": "host",
"display_name_override": "Jane Doe",
"public_visibility": false,
"sort_order": 0,
"id": 42,
"display_name": "Example"
}
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}