Skip to main content

Update a guide details

Category > Guides

For an selected event and under a category the guides are created. So in this same API call:

  • A category will generate
  • A guide will be created

Follow the Request Body description to avoid any error.

NOTE:

  • If new guide is desired to be created under a existing category, just send the existing categor name in the payload.
  • If you add existing category name (case sensitive), then guide ites will be created under same category. If you add new category name a new category will get created. So add values accordingly.
Path Parameters
guideid string REQUIRED
Request Body

Not all properties are required for update. Following are the available options:

  • category can be new or existing but NEVER EMPTY or NULL. Only send the string value, rest will be handled in the backend.

  • title is the name of the guide.

  • content is the guide content.

  • image can be set by an URL of image type.

  • type is ENUM. Allowed types are:

    • richtext, => Normal text or HTML content
    • pdf => For only files
    • weblink => For external redirection
  • displaycategoryorder is the order of the category. Fetch the guide list and match the value

  • displayorder is the order you want for this guide. Mantain the flow.

  • From file1 to file10 can be either Document files or images. Share downloadable links.

    Send type as pdf if files attached.

    Don't keep null file on higher order. If file1 is NULL and url present in file2, SWAP them.

Follow this structure to avoid any error.

category string
content string
image string
title string
type string
files string[]
Responses
200

Success Response

Schema
success boolean

True when API call was successful, false or error otherwise.

default

Error Response

Schema
code int32

Error code.

message string

String description of the error.