Skip to main content

Start Auction

Starts an auction manually.

  • URI: /api/Auctions/{id}/start
  • Method: POST
  • Authentication: Required (JWT)
  • Permission Required: Auctions.Update (default value: "AuctionR:Auctions:Update")

🔐 Permission values are configurable via the Permissions section in appsettings.json.


Route Parameters

FieldTypeRequiredDescription
idintYesID of the auction to start

Sample Request

POST /api/Auctions/789/start HTTP/1.1
Authorization: Bearer {your_jwt_token}

Response

Status Code: 200 OK

Response Body Example

{
"success": true,
"message": "Auction started successfully.",
"data": null
}

Possible Error Responses

Status CodeMeaningWhen it Happens
400Bad RequestInput validation fails (e.g., missing/invalid fields)
401UnauthorizedJWT is missing or invalid
403ForbiddenCaller does not have permission to update auctions or caller's ID doesn't match the auction's owner ID
429Too Many RequestsRate limiting exceeded
500Internal Server ErrorUnexpected server-side error