API Reference

Update speaker position

In this API, you can change the position of the speaker. Default position will be 1000.

In this API, you need to pass three path parameters to change a speaker position.

id :
speaker id whose position we are changing

topSpeakerId :
Id of the speaker below which current speaker we want to place. Pass 0 if you want to move the speaker to the top of the list.

topBottomSpeakerId:
Id of the speaker above which current speaker we want to place. Pass 0 if you want to move the speaker at bottom of the list.

For example:
Let assume we have four speakers called speaker-1, speaker-2, speaker-3, speaker-4.

Now if we want to move speaker-4 between speaker-2 and speaker-3, you need to send speaker-2's id as topSpeakerId and speaker-3's id as topBottomSpeakerId.

If we want to move speaker-2 to the last position, then you need to send speaker-4's id as topSpeakerId and 0 as topBottomSpeakerId.

If we want to move speaker-1 to the first position, then you need to send 0 as topSpeakerId and Tag-1 id as topBottomSpeakerId.

This API can be used by authenticated users only, and it will require super admin/admin/staff level access.

Here is the description of response attributes, which returns to the form of JSON.

AttributesDescription
type This field returns the type of message, like success or error.
message This field returns a message description.

This API Returns a void response with 200 status if the API executed successfully.

Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error CodeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
Language
Credentials
Header
Click Try It! to start a request and see the response here!