REST API: Add Event Featured Image

Adam Ilowite

Published: 12/20/2022

Adam Ilowite

Updated: 1/6/2023

0 (0votes)

Add Event Featured Image

Set the featured image for events. Valid for Communifire version 6.0 and above.

HTTP Method

POST

Response Format

JSON

Requires Authentication?

YES

Product Version

6.0 and above

Required Parameters	How to use	Description
API Key	Used in the request URL: &Token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for.
Image Stream	Used in the request body	Here you have to send the form data the image you want to set as the featured image.
EventID	Used in the request URL as a path parameter	Unique identifier for the event.

Indicator is returned as ResponseData.

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

Please Note The content type that you pass in the header of your request should be multipart/form-data.