Events
Create an event auction item
Configures bidding prices, stock, visibility and auction status. Omitted fields are preserved when updating. Requires the event management capability; all referenced records must belong to this event and organization.
POST
/
admin
/
events
/
{eventId}
/
auction-items
Create an event auction item
curl --request POST \
--url https://api.gratona.com/v1/admin/events/{eventId}/auction-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Annual Gala",
"description": "Example",
"fair_market_value": 1,
"starting_bid": 1,
"buy_now_price": 1,
"quantity_available": 1,
"status": "draft",
"visibility": "public",
"sort_order": 1,
"settings": {}
}
'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/auction-items"
payload = {
"name": "Annual Gala",
"description": "Example",
"fair_market_value": 1,
"starting_bid": 1,
"buy_now_price": 1,
"quantity_available": 1,
"status": "draft",
"visibility": "public",
"sort_order": 1,
"settings": {}
}
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({
name: 'Annual Gala',
description: 'Example',
fair_market_value: 1,
starting_bid: 1,
buy_now_price: 1,
quantity_available: 1,
status: 'draft',
visibility: 'public',
sort_order: 1,
settings: {}
})
};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/auction-items', 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}/auction-items",
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([
'name' => 'Annual Gala',
'description' => 'Example',
'fair_market_value' => 1,
'starting_bid' => 1,
'buy_now_price' => 1,
'quantity_available' => 1,
'status' => 'draft',
'visibility' => 'public',
'sort_order' => 1,
'settings' => [
]
]),
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}/auction-items"
payload := strings.NewReader("{\n \"name\": \"Annual Gala\",\n \"description\": \"Example\",\n \"fair_market_value\": 1,\n \"starting_bid\": 1,\n \"buy_now_price\": 1,\n \"quantity_available\": 1,\n \"status\": \"draft\",\n \"visibility\": \"public\",\n \"sort_order\": 1,\n \"settings\": {}\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}/auction-items")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Annual Gala\",\n \"description\": \"Example\",\n \"fair_market_value\": 1,\n \"starting_bid\": 1,\n \"buy_now_price\": 1,\n \"quantity_available\": 1,\n \"status\": \"draft\",\n \"visibility\": \"public\",\n \"sort_order\": 1,\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/auction-items")
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 \"name\": \"Annual Gala\",\n \"description\": \"Example\",\n \"fair_market_value\": 1,\n \"starting_bid\": 1,\n \"buy_now_price\": 1,\n \"quantity_available\": 1,\n \"status\": \"draft\",\n \"visibility\": \"public\",\n \"sort_order\": 1,\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"client_id": 1,
"event_id": 1,
"name": "Annual Gala",
"description": "Example",
"fair_market_value": "25.00",
"starting_bid": "25.00",
"buy_now_price": "25.00",
"quantity_available": 1,
"quantity_sold": 1,
"status": "draft",
"visibility": "public",
"sort_order": 1,
"settings": {},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z",
"bid_summary": {
"active_bid_count": 42,
"awarded_count": 42,
"bid_count": 42,
"purchased_count": 42,
"high_bid": 0,
"settled_total": 0,
"last_bid_at": "Example",
"leader_at": "Example",
"leader_signature": "Example",
"leader_status": "Example",
"winner": "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
Name.
Maximum string length:
255Example:
"Annual Gala"
Description.
Example:
"Example"
Fair market value.
Required range:
x >= 0Example:
1
Starting bid.
Required range:
x >= 0Example:
1
Buy now price.
Required range:
x >= 0Example:
1
Quantity available.
Required range:
x >= 0Example:
1
Status.
Available options:
draft, open, closed, fulfilled, cancelled, null Example:
"draft"
Visibility.
Available options:
public, private, null Example:
"public"
Sort order.
Example:
1
Settings.
Response
Create an event auction item completed.
Show child attributes
Show child attributes
⌘I
Create an event auction item
curl --request POST \
--url https://api.gratona.com/v1/admin/events/{eventId}/auction-items \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Annual Gala",
"description": "Example",
"fair_market_value": 1,
"starting_bid": 1,
"buy_now_price": 1,
"quantity_available": 1,
"status": "draft",
"visibility": "public",
"sort_order": 1,
"settings": {}
}
'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/auction-items"
payload = {
"name": "Annual Gala",
"description": "Example",
"fair_market_value": 1,
"starting_bid": 1,
"buy_now_price": 1,
"quantity_available": 1,
"status": "draft",
"visibility": "public",
"sort_order": 1,
"settings": {}
}
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({
name: 'Annual Gala',
description: 'Example',
fair_market_value: 1,
starting_bid: 1,
buy_now_price: 1,
quantity_available: 1,
status: 'draft',
visibility: 'public',
sort_order: 1,
settings: {}
})
};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/auction-items', 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}/auction-items",
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([
'name' => 'Annual Gala',
'description' => 'Example',
'fair_market_value' => 1,
'starting_bid' => 1,
'buy_now_price' => 1,
'quantity_available' => 1,
'status' => 'draft',
'visibility' => 'public',
'sort_order' => 1,
'settings' => [
]
]),
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}/auction-items"
payload := strings.NewReader("{\n \"name\": \"Annual Gala\",\n \"description\": \"Example\",\n \"fair_market_value\": 1,\n \"starting_bid\": 1,\n \"buy_now_price\": 1,\n \"quantity_available\": 1,\n \"status\": \"draft\",\n \"visibility\": \"public\",\n \"sort_order\": 1,\n \"settings\": {}\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}/auction-items")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Annual Gala\",\n \"description\": \"Example\",\n \"fair_market_value\": 1,\n \"starting_bid\": 1,\n \"buy_now_price\": 1,\n \"quantity_available\": 1,\n \"status\": \"draft\",\n \"visibility\": \"public\",\n \"sort_order\": 1,\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/auction-items")
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 \"name\": \"Annual Gala\",\n \"description\": \"Example\",\n \"fair_market_value\": 1,\n \"starting_bid\": 1,\n \"buy_now_price\": 1,\n \"quantity_available\": 1,\n \"status\": \"draft\",\n \"visibility\": \"public\",\n \"sort_order\": 1,\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"client_id": 1,
"event_id": 1,
"name": "Annual Gala",
"description": "Example",
"fair_market_value": "25.00",
"starting_bid": "25.00",
"buy_now_price": "25.00",
"quantity_available": 1,
"quantity_sold": 1,
"status": "draft",
"visibility": "public",
"sort_order": 1,
"settings": {},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z",
"bid_summary": {
"active_bid_count": 42,
"awarded_count": 42,
"bid_count": 42,
"purchased_count": 42,
"high_bid": 0,
"settled_total": 0,
"last_bid_at": "Example",
"leader_at": "Example",
"leader_signature": "Example",
"leader_status": "Example",
"winner": "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."
}