Events
Cancel an event auction bid
Sets bid status cancelled and stores cancellation time/user; repeated cancellation preserves its state. Returns the bid with item, order and donor relations. Requires events_manage.
POST
/
admin
/
events
/
{eventId}
/
auction-bids
/
{bidId}
/
cancel
Cancel an event auction bid
curl --request POST \
--url https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel', 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-bids/{bidId}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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-bids/{bidId}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"client_id": 1,
"event_id": 1,
"event_auction_item_id": 1,
"event_order_id": 1,
"donor_id": 1,
"bidder_name": "Example",
"bidder_email": "Example",
"amount": "25.00",
"quantity": 1,
"status": "Example",
"metadata": {},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z",
"item": {
"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"
}
},
"order": {
"id": 1,
"client_id": 1,
"event_id": 1,
"purchaser_donor_id": 1,
"promo_code_id": 1,
"donation_id": 1,
"order_number": "Example",
"status": "Example",
"payment_status": "Example",
"payment_method": "Example",
"gateway": "Example",
"payment_intent_id": "pi_example",
"transaction_id": "transaction_example",
"currency": "Example",
"subtotal_amount": "25.00",
"discount_amount": "25.00",
"fees_covered_amount": "25.00",
"donation_amount": "25.00",
"sponsorship_amount": "25.00",
"tax_deductible_amount": "25.00",
"non_deductible_amount": "25.00",
"total_amount": "25.00",
"purchaser_name": "Example",
"purchaser_email": "Example",
"purchaser_phone": "Example",
"magic_token": "Example",
"idempotency_key": "Example",
"reservation_expires_at": "2026-10-20T12:00:00Z",
"quote_fingerprint": "Example",
"quote_snapshot": {},
"line_items": {},
"metadata": {},
"receipt_snapshot": {},
"paid_at": "2026-10-20T12:00:00Z",
"receipt_sent_at": "2026-10-20T12:00:00Z",
"cancelled_at": "2026-10-20T12:00:00Z",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z",
"attendees_count": 42,
"promo_code": {
"id": 1,
"client_id": 1,
"event_id": 1,
"code": "Example",
"type": "Example",
"value": "25.00",
"max_redemptions": 1,
"redemptions_count": 1,
"per_order_limit": 1,
"starts_at": "2026-10-20T12:00:00Z",
"ends_at": "2026-10-20T12:00:00Z",
"ticket_type_ids": [
1
],
"sponsor_package_ids": [
1
],
"is_active": false,
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z"
}
},
"donor": {
"id": 42,
"first_name": "Example",
"last_name": "Example",
"email": "jane@example.org"
}
}
}{
"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"
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Record ID in the authenticated organization.
Example:
42
Record ID in the authenticated organization.
Example:
42
Response
Cancel an event auction bid completed.
Show child attributes
Show child attributes
⌘I
Cancel an event auction bid
curl --request POST \
--url https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel', 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-bids/{bidId}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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-bids/{bidId}/cancel")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/events/{eventId}/auction-bids/{bidId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 1,
"client_id": 1,
"event_id": 1,
"event_auction_item_id": 1,
"event_order_id": 1,
"donor_id": 1,
"bidder_name": "Example",
"bidder_email": "Example",
"amount": "25.00",
"quantity": 1,
"status": "Example",
"metadata": {},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z",
"item": {
"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"
}
},
"order": {
"id": 1,
"client_id": 1,
"event_id": 1,
"purchaser_donor_id": 1,
"promo_code_id": 1,
"donation_id": 1,
"order_number": "Example",
"status": "Example",
"payment_status": "Example",
"payment_method": "Example",
"gateway": "Example",
"payment_intent_id": "pi_example",
"transaction_id": "transaction_example",
"currency": "Example",
"subtotal_amount": "25.00",
"discount_amount": "25.00",
"fees_covered_amount": "25.00",
"donation_amount": "25.00",
"sponsorship_amount": "25.00",
"tax_deductible_amount": "25.00",
"non_deductible_amount": "25.00",
"total_amount": "25.00",
"purchaser_name": "Example",
"purchaser_email": "Example",
"purchaser_phone": "Example",
"magic_token": "Example",
"idempotency_key": "Example",
"reservation_expires_at": "2026-10-20T12:00:00Z",
"quote_fingerprint": "Example",
"quote_snapshot": {},
"line_items": {},
"metadata": {},
"receipt_snapshot": {},
"paid_at": "2026-10-20T12:00:00Z",
"receipt_sent_at": "2026-10-20T12:00:00Z",
"cancelled_at": "2026-10-20T12:00:00Z",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z",
"attendees_count": 42,
"promo_code": {
"id": 1,
"client_id": 1,
"event_id": 1,
"code": "Example",
"type": "Example",
"value": "25.00",
"max_redemptions": 1,
"redemptions_count": 1,
"per_order_limit": 1,
"starts_at": "2026-10-20T12:00:00Z",
"ends_at": "2026-10-20T12:00:00Z",
"ticket_type_ids": [
1
],
"sponsor_package_ids": [
1
],
"is_active": false,
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"deleted_at": "2026-10-20T12:00:00Z"
}
},
"donor": {
"id": 42,
"first_name": "Example",
"last_name": "Example",
"email": "jane@example.org"
}
}
}{
"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"
}