Loading ...

REST API: Add Event Featured Image | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Add Event Featured Image
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 26

REST API: Add Event Featured Image

0 
 /5
0 (0votes)
Open API Guide
POST/api/events/{EventID}/image

Set the featured image for events

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESmultipart/form-dataMust be set to multipart/form-data

Required Parameters

ParameterTypeRequiredLocationDescription
Image StreamFile StreamYESBodyHere you have to send the form data  the image you want to set as the featured image
EventIDIntegerYESPathUnique identifier for the event

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: multipart/form-data

Request URL

https://your-site.com/api/events/15151/image

Request Body

To set or replace the featured image for a calendar event (displayed on event listings and detail pages) using Postman:

  1. In Postman, select the Body tab
  2. Choose form-data
  3. Add a key named Image Stream
  4. Change the key type from "Text" to File using the dropdown
  5. Click Select Files and choose your image (JPG, PNG, or GIF)

Success Response

{
  "IsError": false,
  "ResponseMessage": "ToBePublished",
  "ResponseData": 1
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required field missing",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (eventID)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
404 Not FoundThe specified event was not found.Verify the eventID is correct.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages