Events
Save the event invitation plan
Replaces the definition and increments revision/lock. Existing applied task snapshots remain unchanged. Supply the current lock, or zero for first save. One to ten steps must be enabled; offsets are 0–365 days, titles allow only donor_name/event_name tokens, specific assignees must be active and see this event. Unknown or duplicate step keys become new generated keys. Requires event setup management; archived event invitation history is read-only (409). Also requires task management permission.
PUT
/
admin
/
events
/
{eventId}
/
invitation-plan
Save the event invitation plan
curl --request PUT \
--url https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Personal invitation",
"expected_lock_version": 0,
"steps": [
{
"label": "Personal call",
"task_title_template": "Call {donor_name} about {event_name}",
"days_before_event": 28,
"step_key": "personal_call",
"position": 42,
"invitation_method": "phone_call",
"assignee_strategy": "invitee_owner",
"assignee_user_id": 42,
"is_enabled": true
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan"
payload = {
"name": "Personal invitation",
"expected_lock_version": 0,
"steps": [
{
"label": "Personal call",
"task_title_template": "Call {donor_name} about {event_name}",
"days_before_event": 28,
"step_key": "personal_call",
"position": 42,
"invitation_method": "phone_call",
"assignee_strategy": "invitee_owner",
"assignee_user_id": 42,
"is_enabled": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Personal invitation',
expected_lock_version: 0,
steps: [
{
label: 'Personal call',
task_title_template: 'Call {donor_name} about {event_name}',
days_before_event: 28,
step_key: 'personal_call',
position: 42,
invitation_method: 'phone_call',
assignee_strategy: 'invitee_owner',
assignee_user_id: 42,
is_enabled: true
}
]
})
};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan', 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}/invitation-plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Personal invitation',
'expected_lock_version' => 0,
'steps' => [
[
'label' => 'Personal call',
'task_title_template' => 'Call {donor_name} about {event_name}',
'days_before_event' => 28,
'step_key' => 'personal_call',
'position' => 42,
'invitation_method' => 'phone_call',
'assignee_strategy' => 'invitee_owner',
'assignee_user_id' => 42,
'is_enabled' => true
]
]
]),
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}/invitation-plan"
payload := strings.NewReader("{\n \"name\": \"Personal invitation\",\n \"expected_lock_version\": 0,\n \"steps\": [\n {\n \"label\": \"Personal call\",\n \"task_title_template\": \"Call {donor_name} about {event_name}\",\n \"days_before_event\": 28,\n \"step_key\": \"personal_call\",\n \"position\": 42,\n \"invitation_method\": \"phone_call\",\n \"assignee_strategy\": \"invitee_owner\",\n \"assignee_user_id\": 42,\n \"is_enabled\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Personal invitation\",\n \"expected_lock_version\": 0,\n \"steps\": [\n {\n \"label\": \"Personal call\",\n \"task_title_template\": \"Call {donor_name} about {event_name}\",\n \"days_before_event\": 28,\n \"step_key\": \"personal_call\",\n \"position\": 42,\n \"invitation_method\": \"phone_call\",\n \"assignee_strategy\": \"invitee_owner\",\n \"assignee_user_id\": 42,\n \"is_enabled\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Personal invitation\",\n \"expected_lock_version\": 0,\n \"steps\": [\n {\n \"label\": \"Personal call\",\n \"task_title_template\": \"Call {donor_name} about {event_name}\",\n \"days_before_event\": 28,\n \"step_key\": \"personal_call\",\n \"position\": 42,\n \"invitation_method\": \"phone_call\",\n \"assignee_strategy\": \"invitee_owner\",\n \"assignee_user_id\": 42,\n \"is_enabled\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"materialized": false,
"id": 42,
"name": "Personal invitation",
"revision": 1,
"lock_version": 1,
"source_preset_key": "personal_invitation_v1",
"source_preset_version": 42,
"definition_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"steps": [
{
"id": 42,
"step_key": "personal_call",
"position": 42,
"label": "Personal call",
"task_title_template": "Call {donor_name} about {event_name}",
"invitation_method": "phone_call",
"days_before_event": 28,
"assignee_strategy": "invitee_owner",
"assignee_user_id": 42,
"is_enabled": true
}
]
}
}{
"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"
}{
"message": "Version, idempotency, preview or archived-event conflict.",
"error_code": "event_invitee_conflict",
"details": {
"current_version": 42,
"current_lock_version": 42,
"current_revision": 42,
"current_definition_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}{
"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
Response
Save the event invitation plan completed.
Show child attributes
Show child attributes
⌘I
Save the event invitation plan
curl --request PUT \
--url https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Personal invitation",
"expected_lock_version": 0,
"steps": [
{
"label": "Personal call",
"task_title_template": "Call {donor_name} about {event_name}",
"days_before_event": 28,
"step_key": "personal_call",
"position": 42,
"invitation_method": "phone_call",
"assignee_strategy": "invitee_owner",
"assignee_user_id": 42,
"is_enabled": true
}
]
}
'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan"
payload = {
"name": "Personal invitation",
"expected_lock_version": 0,
"steps": [
{
"label": "Personal call",
"task_title_template": "Call {donor_name} about {event_name}",
"days_before_event": 28,
"step_key": "personal_call",
"position": 42,
"invitation_method": "phone_call",
"assignee_strategy": "invitee_owner",
"assignee_user_id": 42,
"is_enabled": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Personal invitation',
expected_lock_version: 0,
steps: [
{
label: 'Personal call',
task_title_template: 'Call {donor_name} about {event_name}',
days_before_event: 28,
step_key: 'personal_call',
position: 42,
invitation_method: 'phone_call',
assignee_strategy: 'invitee_owner',
assignee_user_id: 42,
is_enabled: true
}
]
})
};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan', 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}/invitation-plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Personal invitation',
'expected_lock_version' => 0,
'steps' => [
[
'label' => 'Personal call',
'task_title_template' => 'Call {donor_name} about {event_name}',
'days_before_event' => 28,
'step_key' => 'personal_call',
'position' => 42,
'invitation_method' => 'phone_call',
'assignee_strategy' => 'invitee_owner',
'assignee_user_id' => 42,
'is_enabled' => true
]
]
]),
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}/invitation-plan"
payload := strings.NewReader("{\n \"name\": \"Personal invitation\",\n \"expected_lock_version\": 0,\n \"steps\": [\n {\n \"label\": \"Personal call\",\n \"task_title_template\": \"Call {donor_name} about {event_name}\",\n \"days_before_event\": 28,\n \"step_key\": \"personal_call\",\n \"position\": 42,\n \"invitation_method\": \"phone_call\",\n \"assignee_strategy\": \"invitee_owner\",\n \"assignee_user_id\": 42,\n \"is_enabled\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Personal invitation\",\n \"expected_lock_version\": 0,\n \"steps\": [\n {\n \"label\": \"Personal call\",\n \"task_title_template\": \"Call {donor_name} about {event_name}\",\n \"days_before_event\": 28,\n \"step_key\": \"personal_call\",\n \"position\": 42,\n \"invitation_method\": \"phone_call\",\n \"assignee_strategy\": \"invitee_owner\",\n \"assignee_user_id\": 42,\n \"is_enabled\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/invitation-plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Personal invitation\",\n \"expected_lock_version\": 0,\n \"steps\": [\n {\n \"label\": \"Personal call\",\n \"task_title_template\": \"Call {donor_name} about {event_name}\",\n \"days_before_event\": 28,\n \"step_key\": \"personal_call\",\n \"position\": 42,\n \"invitation_method\": \"phone_call\",\n \"assignee_strategy\": \"invitee_owner\",\n \"assignee_user_id\": 42,\n \"is_enabled\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"materialized": false,
"id": 42,
"name": "Personal invitation",
"revision": 1,
"lock_version": 1,
"source_preset_key": "personal_invitation_v1",
"source_preset_version": 42,
"definition_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"steps": [
{
"id": 42,
"step_key": "personal_call",
"position": 42,
"label": "Personal call",
"task_title_template": "Call {donor_name} about {event_name}",
"invitation_method": "phone_call",
"days_before_event": 28,
"assignee_strategy": "invitee_owner",
"assignee_user_id": 42,
"is_enabled": true
}
]
}
}{
"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"
}{
"message": "Version, idempotency, preview or archived-event conflict.",
"error_code": "event_invitee_conflict",
"details": {
"current_version": 42,
"current_lock_version": 42,
"current_revision": 42,
"current_definition_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}