---
title: "REST API: Add Event Featured Image"
type: "wiki"
space: "Axero Documentation"
author: "Adam Ilowite"
created: 2022-12-20T14:23:49Z
updated: 2026-02-23T03:17:32Z
url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/92908/rest-api-add-event-featured-image"
---

# REST API: Add Event Featured Image

[Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=92908)
POST/api/events/\{EventID\}/image

Set the featured image for events

## Request

### Request Header
| Header | Required | Value | Description |
| :--- | :--- | :--- | :--- |
| `Authorization` | YES | `Bearer YOUR_TOKEN` | Bearer token for the authenticated user. [Learn how to create Bearer tokens](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens). |
| `Content-Type` | YES | `multipart/form-data` | Must be set to `multipart/form-data` |
### Required Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `Image Stream` | File Stream | YES | Body | Here you have to send the form data  the image you want to set as the featured image |
| `EventID` | Integer | YES | Path | Unique 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 Code | Likely Cause | Next Action |
| :--- | :--- | :--- |
| 400 Bad Request | One or more required fields are missing or invalid. \(eventID\) | Verify the request payload against the required parameters. |
| 401 Unauthorized | Missing or invalid Bearer token. | Check token validity. [Learn how to create Bearer tokens →](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens) |
| 403 Forbidden | User does not have sufficient permissions. | Confirm the user has the required roles for this action. |
| 404 Not Found | The specified event was not found. | Verify the eventID is correct. |
| 500 Server Error | Internal 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.