API Dashboard

Taffy 3.1.0

Resources:

videoCompression DELETE PATCH PUT POST GET /video-compression

Request Body:

Loading...

Response:

POST
Functionality: Compress a video file;

Form Data:
i) video_file - Type: File; Required

Headers:
i) authorization - Type: String;
Return:
Compressed video URL

verifyUserByOTP DELETE PATCH PUT POST GET /verifyUserOTP

Request Body:

Loading...

Response:

POST
Functionality:User Verification by OTP;

Query Params:
i) OTP - Type:String ; Required
i) Email - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
User Verification by OTP;

userFollowingPosts DELETE PATCH PUT POST GET /user/following/posts

Request Body:

Loading...

Response:

GET
Functionality:Following user posts;

Query Params:
i) user_follower_id - Type:String ; required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;

userIdReels DELETE PATCH PUT POST GET /user/{user_id}/reels

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Functionality: Get reels uploaded by a specific user;

Query Params:
i) user_id - Type: String; Required (path parameter)
ii) page_number - Type: Numeric; Optional (default: 1)
iii) page_size - Type: Numeric; Optional (default: 20)

Headers:
i) authorization - Type: String;
Return:
Specified user's reels

userReels DELETE PATCH PUT POST GET /user-reels

Request Body:

Loading...

Response:

GET
Functionality: Get reels uploaded by current user;

Query Params:
i) page_number - Type: Numeric; Optional (default: 1)
ii) page_size - Type: Numeric; Optional (default: 20)

Headers:
i) authorization - Type: String;
Return:
User's reels

user DELETE PATCH PUT POST GET /user

Request Body:

Loading...

Response:

GET
Functionality:GET User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
GET Users;
DELETE
Functionality:Register User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
New User Id;
PUT
Functionality:Register User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
New User Id;
POST
Functionality: Register User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
New User Id;
PATCH
Functionality:Update Password;

Query Params:
i) user_id - Type:String ; Required
i) new_password - Type:String ; Required
i) old_password - Type:String ; Required Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Password;

uplaodImage DELETE PATCH PUT POST GET /upload_media

Request Body:

Loading...

Response:

POST
Functionality:Upload Media (Images, Videos, Audio);

Form Data:
i) media - Type: File; Required (Supported formats: jpg, jpeg, png, gif, mp4, mov, avi, mp3, wav)
ii) type - Type: String; Required (image/video)

Headers:
i) authorization - Type: String;
Return:
Uploaded media URLs with type information

updateUserEmailOrPhoneNumber DELETE PATCH PUT POST GET /update_user_email_and_number

Request Body:

Loading...

Response:

DELETE
Functionality:Register User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
New User Id;
PUT
Functionality:Register User;

Query Params: Accept: NA;

Headers:
i) authorization - Type: String;
Return:
New User Id;
PATCH
Functionality:Update Password;

Query Params:
i) user_id - Type:String ; Required
i) new_password - Type:String ; Required
i) old_password - Type:String ; Required Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Password;

twilioOtpCheck DELETE PATCH PUT POST GET /twilio_otp_check

Request Body:

Loading...

Response:

POST
Send Twilio Otp verification.

twilioOtp DELETE PATCH PUT POST GET /twilio_otp

Request Body:

Loading...

Response:

POST
Send Twilio Otp.

echo DELETE PATCH PUT POST GET /test_endpoint

Request Body:

Loading...

Response:

GET
Functionality: Echo back the input text using CLI command;

Query Params:
i) input - Type: String - Text to echo back (optional);

Headers: NA
Return: Echo response with CLI output and timestamp

storyViews DELETE PATCH PUT POST GET /story/views

Request Body:

Loading...

Response:

GET
Functionality: Get viewers for a story;

Query Params:
i) story_id - Type:String ; Required

Headers:
i) token - Type: String; Required
Return:
Story viewers with details;
POST
Functionality: Add a view for a story;

Body Params:
i) story_id - Type:String ; Required

Headers:
i) token - Type: String; Required
Return:
View details;

stories DELETE PATCH PUT POST GET /stories

Request Body:

Loading...

Response:

GET
Functionality:Get stories;

Query Params:
i) story_id - Type:String ; Optional
ii) user_id - Type:String ; Required
iii) include_viewers - Type:Boolean ; Optional (default: false)


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Stories data;
DELETE
Functionality:Delete Story;

Query Params:
i) story_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Story;
POST
Functionality:Create stories;

Query Params:
i) user_id - Type:String ; Required
i) content - Type:String ; Required
i) is_public - Type:String ; Required
i) is_viewed - Type:String ; Required
i) story_media - Type:String ; Required
i) created_at - Type:String ; Optional (timestamp)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
stories;
PATCH
Functionality:Mark a story as seen by the current user;

Query Params:
i) story_id - Type:String ; Required

Accept: NA;

Headers:
i) token - Type: String; Required
Return:
Success status and message;

sendOTPtoemail DELETE PATCH PUT POST GET /send-otp-to-email

Request Body:

Loading...

Response:

POST
Send OTP for to the email for verification

search DELETE PATCH PUT POST GET /search

Request Body:

Loading...

Response:

GET
Functionality:Search

Query Params:
i) client_id - Type:numeric ; Required
ii) search_for - Type:string ; Required (Value: Label)
iii) search_value - Type:string ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Search

resetPasswordUsingPhoneNumber DELETE PATCH PUT POST GET /resetPasswordUsingPhoneNumber

Request Body:

Loading...

Response:

POST
Reset password after OTP verification

resetPasswordUsingOTP DELETE PATCH PUT POST GET /resetPasswordUsingOTP

Request Body:

Loading...

Response:

POST
Reset password after OTP verification

resetPassword DELETE PATCH PUT POST GET /resetPassword

Request Body:

Loading...

Response:

POST
Functionality:Reset Password;

Query Params:
i) reset_id Type:String ; Required
ii) new_password Type:String ; Required
iii) verify_password Type:String ; Required

Accept: NA;

Headers:
Return:
NA;

requestOTP DELETE PATCH PUT POST GET /requestOTPForResetPass

Request Body:

Loading...

Response:

POST
Request OTP for password reset

repost DELETE PATCH PUT POST GET /reposts

Request Body:

Loading...

Response:

GET
Functionality:Get Reposts;

Query Params:
i) user_id - Type:String ; Optional
ii) post_id - Type:String ; Optional
iii) repost_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Repost Data;
DELETE
Functionality:Delete Repost;

Query Params:
i) repost_id - Type:String ; Required
ii) user_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Delete Repost Status;
PUT
Functionality:Update Repost;

Query Params:
i) repost_id - Type:String ; Required
ii) user_id - Type:String ; Required
iii) description - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Updated Repost;
POST
Functionality:Create Repost;

Query Params:
i) user_id - Type:String ; Required
ii) post_id - Type:String ; Required
iii) description - Type:String ; Optional
iv) created_at - Type:Date ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Repost;

reportUserStories DELETE PATCH PUT POST GET /reportContentOrUser

Request Body:

Loading...

Response:

POST
Functionality:Create Report;

Query Params:
i) reported_by_id - Type:String ; Required
ii) content_type - Type:String ; Required
iii) content_id - Type:String ; Required
iv) reason - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Report;

report DELETE PATCH PUT POST GET /report

Request Body:

Loading...

Response:

GET
Functionality:Get excel file download link

Query Params:
i) client_id - Type:numeric ; Required
ii) start_date - Type:date ; Required
iii) end_date - Type:numeric ; Required
iv) lab_result - Type:numeric ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Labels

reels DELETE PATCH PUT POST GET /reels

Request Body:

Loading...

Response:

GET
Functionality: Get Reels Feed;

Query Params:
i) feed_type - Type: String; Required (following/foryou/profile)
ii) page_number - Type: Numeric; Optional (default: 1)
iii) page_size - Type: Numeric; Optional (default: 10)
iv) target_user_id - Type: String; Optional (Required when feed_type is profile)

Headers:
i) authorization - Type: String;
Return:
Reels Feed
DELETE
Functionality: Delete a reel;

Query Params:
i) reel_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Deletion status
PUT
Functionality: Update a reel;

Query Params:
i) reel_id - Type: String; Required
ii) caption - Type: String; Optional
iii) location - Type: String; Optional
iv) privacy_setting - Type: String; Optional
v) comments_enabled - Type: Boolean; Optional
vi) cover_image - Type: String; Optional

Headers:
i) authorization - Type: String;
Return:
Updated reel details
POST
Functionality: Create New Reel;

Query Params:
i) video_file - Type: String; Required
ii) cover_image - Type: String; Optional
iii) thumbnail - Type: String; Optional
iv) caption - Type: String; Optional
v) location - Type: String; Optional
vi) hashtags - Type: Array; Optional
vii) tagged_users - Type: Array; Optional
viii) audio_track - Type: String; Optional
ix) privacy_setting - Type: String; Required (public/private/followers)
x) comments_enabled - Type: Boolean; Optional
xi) created_at - Type: String; Optional (timestamp)

Headers:
i) authorization - Type: String;
Return:
Created Reel Details
PATCH
Functionality: Increment view count of a reel;

Query Params:
i) reel_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Updated view count status

reelTaggedUsers DELETE PATCH PUT POST GET /reel-tagged-users

Request Body:

Loading...

Response:

GET
Functionality: Get reels where user is tagged;

Query Params:
i) tagged_user_ids - Type: String; Optional (defaults to authenticated user, comma-separated for multiple users)
ii) page_number - Type: Numeric; Optional (default: 1)
iii) page_size - Type: Numeric; Optional (default: 20)

Headers:
i) authorization - Type: String;
Return:
Reels where user is tagged

reelSaves DELETE PATCH PUT POST GET /reel-saves

Request Body:

Loading...

Response:

GET
Functionality: Get saved reels;

Query Params:
i) page_number - Type: Numeric; Optional (default: 1)
ii) page_size - Type: Numeric; Optional (default: 20)

Headers:
i) authorization - Type: String;
Return:
List of saved reels
POST
Functionality: Save/Unsave a reel;

Query Params:
i) reel_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Save status

reelLikes DELETE PATCH PUT POST GET /reel-likes

Request Body:

Loading...

Response:

POST
Functionality: Like/Unlike a reel;

Query Params:
i) reel_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Like status

reelHashtags DELETE PATCH PUT POST GET /reel-hashtags

Request Body:

Loading...

Response:

GET
Functionality: Get reels by hashtags;

Query Params:
i) hashtags - Type: String; Required (comma-separated hashtags)
ii) match_type - Type: String; Optional (any/all, default: any)
iii) page_number - Type: Numeric; Optional (default: 1)
iv) page_size - Type: Numeric; Optional (default: 20)

Headers:
i) authorization - Type: String;
Return:
Reels with specified hashtags

reelDrafts DELETE PATCH PUT POST GET /reel-drafts

Request Body:

Loading...

Response:

GET
Functionality: Get Reel Drafts;

Query Params:
i) page_number - Type: Numeric; Optional (default: 1)
ii) page_size - Type: Numeric; Optional (default: 20)

Headers:
i) authorization - Type: String;
Return:
List of reel drafts
DELETE
Functionality: Delete a reel draft;

Query Params:
i) draft_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Deletion status
PUT
Functionality: Update a reel draft;

Query Params:
i) draft_id - Type: String; Required
ii) video_file - Type: String; Optional
iii) thumbnail - Type: String; Optional
iv) caption - Type: String; Optional
v) location - Type: String; Optional
vi) hashtags - Type: Array; Optional
vii) tagged_users - Type: Array; Optional
viii) audio_track - Type: String; Optional
ix) privacy_setting - Type: String; Optional
x) comments_enabled - Type: Boolean; Optional

Headers:
i) authorization - Type: String;
Return:
Updated draft details
POST
Functionality: Create New Reel Draft;

Query Params:
i) video_file - Type: String; Optional
ii) thumbnail - Type: String; Optional
iii) caption - Type: String; Optional
iv) location - Type: String; Optional
v) hashtags - Type: Array; Optional
vi) tagged_users - Type: Array; Optional
vii) audio_track - Type: String; Optional
viii) privacy_setting - Type: String; Optional (public/private/followers)
ix) comments_enabled - Type: Boolean; Optional
x) created_at - Type: String; Optional (timestamp)

Headers:
i) authorization - Type: String;
Return:
Created Draft Details
PATCH
Functionality: Publish a draft as a reel;

Query Params:
i) draft_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Published reel details

reelComments DELETE PATCH PUT POST GET /reel-comments

Request Body:

Loading...

Response:

GET
Functionality: Get comments for a reel;

Query Params:
i) reel_id - Type: String; Required
ii) page_number - Type: Numeric; Optional (default: 1)
iii) page_size - Type: Numeric; Optional (default: 20)

Headers:
i) authorization - Type: String;
Return:
Comments list
DELETE
Functionality: Delete a comment from a reel;

Query Params:
i) comment_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Deletion status
POST
Functionality: Add a comment or reply to a reel;

Query Params:
i) reel_id - Type: String; Required
ii) comment - Type: String; Required
iii) parent_comment_id - Type: String; Optional (for replies)
iv) created_at - Type: String; Optional (timestamp)

Headers:
i) authorization - Type: String;
Return:
Created comment/reply details

reel DELETE PATCH PUT POST GET /reel

Request Body:

Loading...

Response:

GET
Functionality: Retrieve a specific reel by ReelID;

Query Params:
i) reel_id - Type:String ; Required

Headers:
i) authorization - Type: String;
Return:
Reel details;

profile DELETE PATCH PUT POST GET /profile

Request Body:

Loading...

Response:

GET
Functionality:Get profile details;

Query Params:
i) client_id - Type:Numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
User Details;
PUT
Functionality:Update profile;

Query Params:
i) client_id - Type:Numeric ; Required
ii) email - Type:String ; Optional
iii) phone - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
NA;
PATCH
Functionality:Update Password;

Query Params:
i) client_id Type:Numeric ; Required
ii) current_password Type:String ; Required
iii) new_password Type:String ; Required
iv) verify_password Type:String ; Required

Accept: NA;

Headers:
i) Authorization: - Type: VARCHAR;
Return:
NA;

privacySetting DELETE PATCH PUT POST GET /privacysettings

Request Body:

Loading...

Response:

GET
Functionality:Get Privacy Settings;

Query Params:
i) user_id - Type:String ; Required
ii) privacy_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Privacy Settings;
DELETE
Functionality:Get Privacy Settings;

Query Params:
i) user_id - Type:String ; Required
ii) privacy_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Privacy Settings;
PUT
Functionality:Update Privacy Settings;

Query Params:
i) user_id - Type:String ; Required
ii) user_id - Type:String ; Required
iii) visibility - Type:String ; Required
iv) notifications - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Privacy Settings;
POST
Functionality:Create Privacy Settings;

Query Params:
i) user_id - Type:String ; Required
ii) visibility - Type:String ; Required
ii) notifications - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Privacy Settings;

postTag DELETE PATCH PUT POST GET /postTag

Request Body:

Loading...

Response:

GET
Functionality:Get Post Tags;

Query Params:
i) tag_id - Type:String ; Optional
ii) post_id - Type:String ; Optional
iii) user_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post Tag;
DELETE
Functionality:Delete Post Tags;

Query Params:
i) tag_id - Type:String ; Optional
ii) post_id - Type:String ; Optional
iii) user_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post Tag;
PUT
Functionality:Update Post Tag;

Query Params:
i) tag_id - Type:String ; Required
ii) post_id - Type:String ; Required
iii) user_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;
POST
Functionality:Create Post Tag;

Body Params:
i) post_id - Type:String ; Required
ii) user_id - Type:String ; Required

Accept: application/json;

Headers:
i) authorization - Type: String;
Return:
Post;

post DELETE PATCH PUT POST GET /post

Request Body:

Loading...

Response:

GET
Functionality:Get Posts;

Query Params:
i) userid - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;
DELETE
Functionality:Get Posts;

Query Params:
i) userid - Type:String ; Required
ii)postid - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;
PUT
Functionality:Get Posts;

Query Params:
i) userid - Type:String ; Required
i) content - Type:String ; Required
i) media - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;
POST
Functionality:Get Posts;

Query Params:
i) userid - Type:String ; Required
i) content - Type:String ; Required
i) media - Type:String ; Required
i) created_at - Type:Date ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;

notification DELETE PATCH PUT POST GET /notifications

Request Body:

Loading...

Response:

GET
Functionality: Get Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) notification_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Get Notifications;
DELETE
Functionality:Delete Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) notification_id Type:String: Required

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Notifications;
PUT
Functionality:Update Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) type - Type:String ; Required
iii) related_id Type:String ; Reuired
iv) read_messages Type:String: Required
v) notification_id Type:String: Required

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Notifications;
POST
Functionality:Create Notifications;

Query Params:
i) user_id - Type:String ; Required
ii) type - Type:String ; Required
iii) related_id Type:String ; Reuired
iv) read_messages Type:String: Required
v) created_at - Type:String ; Optional (timestamp)

Accept: NA;

Headers:
i) authorization - Type:String;
Return:
Notifications;

message DELETE PATCH PUT POST GET /messages

Request Body:

Loading...

Response:

GET
Functionality:Get Messages by Conversation ID;

Query Params:
i) conversation_id - Type:String ; Required
ii) message_id - Type:String ; Optional
iii) sender_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
DELETE
Functionality:Delete Messages;

Query Params:
i) message_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
PUT
Functionality:Create Messages;

Query Params:
i) message_id - Type:String ; Required
ii) conversation_id - Type:String ; Required
iii) sender_id - Type:String ; Required
iv) content - Type:String ; Required
v) type - Type:String ; Required (text, image, reel, post, etc.)
vi) status - Type:String ; Required
vii) image_key - Type:String ; Optional (For image message or text with image)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
POST
Functionality:Create Messages;

Query Params:
i) conversation_id - Type:String ; Required
ii) sender_id - Type:String ; Required
iii) content - Type:String ; Required
iv) type - Type:String ; Required (text, image, reel, post, etc.)
v) status - Type:String ; Required
vi) image_key - Type:String ; Optional (For image message or text with image)
vii) created_at - Type:String ; Optional (timestamp)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Messages;
PATCH
Functionality: Update Message Status;

Query Params:
i) message_id - Type:String ; Required
ii) status - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Message Status;

media DELETE PATCH PUT POST GET /media

Request Body:

Loading...

Response:

POST
Functionality:Upload Media;

Query Params:
i) userid - Type:String ; Required
i) content - Type:String ; Required
i) media - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;

worldLabelValLocation DELETE PATCH PUT POST GET /maps/worldLabelValLocation

Request Body:

Loading...

Response:

GET
Functionality:Get world label validation location.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Label validation locations

topUSStates DELETE PATCH PUT POST GET /maps/topUSStates

Request Body:

Loading...

Response:

GET
Functionality:Get top US states

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Top US states

topCountries DELETE PATCH PUT POST GET /maps/topCountries

Request Body:

Loading...

Response:

GET
Functionality:Get top countries

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Top countries

topCities DELETE PATCH PUT POST GET /maps/topCities

Request Body:

Loading...

Response:

GET
Functionality:Get top cities

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Top cities

regionDetail DELETE PATCH PUT POST GET /maps/regionDetail

Request Body:

Loading...

Response:

GET
Functionality:Get region label validation location detail.

Query Params:
i) client_id - Type:numeric ; Required
ii) region_code - Type:string ; Required
iii) start_date - Type:date ; Optional
iv) end_date - Type:date ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Region detail label validation locations

labelValidationLocation DELETE PATCH PUT POST GET /maps/labelValidationLocation

Request Body:

Loading...

Response:

GET
Functionality:Get label validation location.

Query Params:
i) client_id - Type:numeric ; Required
ii) start_date - Type:date ; Optional
iii) end_date - Type:date ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Label validation locations

like DELETE PATCH PUT POST GET /likes

Request Body:

Loading...

Response:

GET
Functionality:Get Likes;

Query Params:
i) user_id - Type:String ; Optional
ii) post_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post Tag;
DELETE
Functionality:Delete Likes;

Query Params:
i) like_id - Type:String ; Optional
ii) user_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Likes;
PUT
Functionality:Toggle Like (add or remove);

Query Params:
i) post_id - Type:String ; Required
ii) repost_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Toggle like status and count;
POST
Functionality:Create Likes;

Query Params:
i) user_id - Type:String ; Required
i) post_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;

lastSeen DELETE PATCH PUT POST GET /last_seen

Request Body:

Loading...

Response:

GET
Functionality:Get Last Seen;

Query Params:
i) userid - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Last Seen;
PATCH
Functionality:Add or Update Last Seen;

Query Params:
i) userid - Type:String ; Required
ii) created_at - Type:String ; Optional (timestamp)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Last Seen;

lastSeenVisibility DELETE PATCH PUT POST GET /lastSeenVisibility

Request Body:

Loading...

Response:

GET
Functionality: Get last seen visibility setting;

Headers:
i) token - Type: String; Required
Return:
Current visibility setting;
PUT
Functionality: Update last seen visibility setting;

Body Params:
i) is_visible - Type:Boolean ; Required

Headers:
i) token - Type: String; Required
Return:
Updated visibility setting;

label DELETE PATCH PUT POST GET /label

Request Body:

Loading...

Response:

GET
Functionality:Get labels

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Labels

inviteUser DELETE PATCH PUT POST GET /invite_user

Request Body:

Loading...

Response:

POST
Send Twilio invitation message

storeInviteDetails DELETE PATCH PUT POST GET /invite-details

Request Body:

Loading...

Response:

GET
Functionality: Fetch Conversion IDs for a Mobile Number;

Query Params:
i) mobileNumber - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversion IDs associated with the Mobile Number.
DELETE
Functionality: Delete Invite Records for a Mobile Number;

Request Body:
i) mobileNumber - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Status of the deletion.
POST
Functionality: Store Invite Details (Mobile Number and Conversion ID);

Request Body:
i) mobileNumber - Type:String ; Required
ii) conversion_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Status of the operation.

hashtagSearch DELETE PATCH PUT POST GET /hashtag-search

Request Body:

Loading...

Response:

GET
Functionality: Search for hashtags dynamically;

Query Params:
i) search_term - Type: String; Required
ii) limit - Type: Numeric; Optional (default: 10)

Headers:
i) authorization - Type: String;
Return:
List of matching hashtags with usage counts

forgotPassword DELETE PATCH PUT POST GET /forgotPassword

Request Body:

Loading...

Response:

POST
Functionality:Forgot password

Query Params:
i) email - Type:String ; Required

Accept: NA;

Headers:
i) app_name - Type: String;
Return:
NA

follower DELETE PATCH PUT POST GET /followers

Request Body:

Loading...

Response:

GET
Functionality:Get Followers;

Query Params:
i) user_id - Type:String ; Optional
ii) following_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Followers;
DELETE
Functionality:Delete Followers;

Query Params:
i) follower_id - Type:String ; Optional
ii) user_id - Type:String ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Followers;
POST
Functionality:Create followers;

Query Params:
i) user_id - Type:String ; Required
i) following_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
follower;

handleFollowRequest DELETE PATCH PUT POST GET /followerRequests

Request Body:

Loading...

Response:

GET
Functionality:Get all follower requests for the current user;

Query Params:
i) user_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Follower Requests;
POST
Functionality:Handle follow requests (accept/reject);

Query Params:
i) request_id - Type:String ; Required
ii) action - Type:String ; Required (accept/reject)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Follow request status update;

fileUpload DELETE PATCH PUT POST GET /file-upload

Request Body:

Loading...

Response:

POST
Functionality: Generates a presigned URL for direct file upload to S3.

Query Params:
i) file_name - Type: String; Required
ii) file_type - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Presigned URL for uploading the file directly to S3.

fileDownload DELETE PATCH PUT POST GET /file-download

Request Body:

Loading...

Response:

GET
Functionality: Generates a presigned URL for downloading a file from S3.

Query Params:
i) file_key - Type: String; Required

Headers:
i) authorization - Type: String; Required
Return:
Presigned URL for downloading the file from S3.

fcmToken DELETE PATCH PUT POST GET /fcm_token

Request Body:

Loading...

Response:

PATCH
Functionality:Add or Update Fcm Token;

Query Params:
i) user_id - Type:String ; Required


ii) fcm_token - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Fcm Token;

fcmNotification DELETE PATCH PUT POST GET /fcm_notification

Request Body:

Loading...

Response:

POST
Send Firebase Cloud Messaging notifications to multiple devices.

fcmAccessToken DELETE PATCH PUT POST GET /fcm_access_token

Request Body:

Loading...

Response:

POST
Functionality:FCM Access Token;

Query Params:
i) fcm_token - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
FCM Access Token;

emailPreview DELETE PATCH PUT POST GET /email/preview

Request Body:

Loading...

Response:

GET
Functionality:Get the email preview.

Query Params:
i) client_id - Type:numeric ; Required
ii) content - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

demoApi DELETE PATCH PUT POST GET /demo

Request Body:

Loading...

Response:

get

socialMediaClick DELETE PATCH PUT POST GET /dashboard/socialMediaClick

Request Body:

Loading...

Response:

GET
Functionality:Get social media clicks

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Scoail media click counts

serialValidationVerified DELETE PATCH PUT POST GET /dashboard/serialValidationVerified

Request Body:

Loading...

Response:

GET
Functionality:Get serial validation verified.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Serial validation verified count and percentage data

mostRecent DELETE PATCH PUT POST GET /dashboard/mostRecent

Request Body:

Loading...

Response:

GET
Functionality:Get the most recent email list.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

labelValidation DELETE PATCH PUT POST GET /dashboard/labelValidation

Request Body:

Loading...

Response:

GET
Functionality:Get label validation.

Query Params:
i) client_id - Type:numeric ; Required
ii) period - Type:string ; Optional default 'period':'weekly' hint - ('period':'weekly', 'period':'monthly')

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Most recent email list

currentUserFollowing DELETE PATCH PUT POST GET /current_user/following

Request Body:

Loading...

Response:

GET
Functionality:Current_user following;

Query Params:
i) current_user_following_id - Type:String ; required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Current_user following;

currentUserFollowers DELETE PATCH PUT POST GET /current_user/followers

Request Body:

Loading...

Response:

GET
Functionality:Current_user followers;

Query Params:
i) current_user_id - Type:String ; required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Current_user followers;

conversation DELETE PATCH PUT POST GET /conversations

Request Body:

Loading...

Response:

GET
Functionality: Get All Conversations;

Query Params: user_id (optional)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversations;
DELETE
Functionality:Delete Converstions;

Query Params:
i) conversation_id - Type:String ;


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversations;
PUT
Functionality: Update conversation details;

Query Params:
i) conversation_id - Type:String; Required
ii) group_image - Type:String; Optional (Base64 encoded image or image URL)
iii) name - Type:String; Optional

Headers:
i) authorization - Type: String;
Return:
Status of update operation;
POST
Functionality:Create Converstions;

Query Params:
i) conversation_type - Type:String ;
ii) name - Type:String ; Optional
iii) created_at - Type:Date ; Optional


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversations;
PATCH
Functionality: Update is_pin and is_mute status for a conversation;

Query Params:
i) conversation_id - Type:String; Required
ii) is_pin - Type:Boolean; Optional
iii) is_mute - Type:Boolean; Optional
iv) participant_id - Type:String; Required

Headers:
i) authorization - Type: String;
Return:
Status of update operation;

conversationParticipants DELETE PATCH PUT POST GET /conversation_participants

Request Body:

Loading...

Response:

GET
Functionality: - Get Conversation Participants by Conversation ID OR - Get all Conversations by User ID;

Query Params:
i) conversation_id - Type:String ; Optional
ii) user_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
- If conversation_id is passed: Conversation Participants
- If user_id is passed: Conversations related to the user (participant);
DELETE
Functionality: Delete conversation participant;

Query Params:
i) participant_id - Type: String; Required
ii) type - Type: String; Required


Accept: NA;

Headers:
i) authorization - Type: String;
Return:
conversation participant;
PUT
Functionality:Update conversation participants;

Query Params:
i) conversation_id - Type:String ; Required
i) user_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
conversation participants;
POST
Functionality:Create conversation participants;

Query Params:
i) user_id - Type:String ; Required
i) conversation_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
conversation participants;

conversationCheck DELETE PATCH PUT POST GET /conversation/check

Request Body:

Loading...

Response:

POST
Functionality: Check for existing conversation between two users or create a new one;

Query Params:
i) source_user_id - Type:String ; Required ; User initiating the conversation
ii) target_user_id - Type:String ; Required ; User being targeted for conversation

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Conversation ID and creation status;

contentViews DELETE PATCH PUT POST GET /content/views

Request Body:

Loading...

Response:

POST
Functionality: Add a view for a reel or post;

Body Params:
i) content_id - Type:String ; Required
ii) content_type - Type:String ; Required (either 'reel' or 'post')

Headers:
i) token - Type: String; Required
Return:
View details;

contentViewCount DELETE PATCH PUT POST GET /content/viewcount

Request Body:

Loading...

Response:

GET
Functionality: Get total view count for a specific reel or post;

Query Params:
i) content_id - Type:String ; Required
ii) content_type - Type:String ; Required (either 'reel' or 'post')

Headers:
i) token - Type: String; Required
Return:
Total view count;

dropdown DELETE PATCH PUT POST GET /common/dropdown

Request Body:

Loading...

Response:

GET
Functionality:Get all dropdowns.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Drop downs data

commentLikes DELETE PATCH PUT POST GET /comment-likes

Request Body:

Loading...

Response:

POST
Functionality: Like/Unlike a comment;

Query Params:
i) comment_id - Type: String; Required

Headers:
i) authorization - Type: String;
Return:
Like status

comment DELETE PATCH PUT POST GET /comment

Request Body:

Loading...

Response:

GET
Functionality:Get Comments;

Query Params:
i) user_id - Type:String ; Optional
ii) post_id - Type:String ; Optional
iii) repost_id - Type:String ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;
DELETE
Functionality:Get Posts;

Query Params:
i) userid - Type:String ; Required
ii)postid - Type:String ; Required
iii)commentid - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;
PUT
Functionality:Get Posts;

Query Params:
i) userid - Type:String ; Required
ii) content - Type:String ; Required
iii) postid - Type:String ; Required
iv) commentid - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Post;
POST
Functionality:Create Comment or Reply;

Query Params:
i) user_id - Type:String ; Required
ii) content - Type:String ; Required
iii) post_id - Type:String ; Required
iv) repost_id - Type:String ; Optional (for comments on reposts)
v) parent_comment_id - Type:String ; Optional (for replies)
vi) created_at - Type:String ; Optional (timestamp)

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
Created comment/reply;

clientPreviousEmail DELETE PATCH PUT POST GET /client/previousEmail

Request Body:

Loading...

Response:

GET
Functionality:Get the email recipients list.

Query Params:
i) client_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list
DELETE
Functionality:Delete the previous email list.

Query Params:
i) client_id - Type:numeric ; Required
ii) msg_id - Type:numeric ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

client DELETE PATCH PUT POST GET /client

Request Body:

Loading...

Response:

GET
Functionality:Get the email recipients list.

Query Params:
i) client_id - Type:numeric ; Required
ii) paginate - Type:boolean ; Optional (DEFAULT - true)
iii) offset - Type:numeric ; Conditional (If paginate is true the offset is required param)
iv) msg_id - Type:numeric ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list
POST
Functionality:Saves the email message to send after approval.

Query Params:
i) client_id - Type:numeric ; Required
ii) from_email - Type:string ; Required
iii) recipient_ids - Type:string ; Conditional hint('recipient_ids':'1,2,3,4')
iv) email_content - Type:string ; Required
v) sendToAll - Type:Boolean ; Optional (Default : 0)
vi) msg_id - Type:numeric ; Optional

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
email list

blockedUser DELETE PATCH PUT POST GET /blocked_user

Request Body:

Loading...

Response:

GET
Functionality: Get all blocked users for a given user_id;

Query Params:
i) user_id - Type: String ; Required

Headers:
i) authorization - Type: String;
Return:
Returns a list of blocked users with their details;
DELETE
Functionality:Add blocked users;

Query Params:
i) blocker_id - Type:String ; Required
ii) blocked_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
blocked users;
POST
Functionality:Add blocked users;

Query Params:
i) blocker_id - Type:String ; Required
ii) blocked_id - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
blocked users;

login DELETE PATCH PUT POST GET /authenticate

Request Body:

Loading...

Response:

POST
Functionality: Validate User Credentials;

Query Params:
i) identifier (email/phone/username) - Type:String ; Required
ii) password - Type:String ; Required

Accept: NA;

Headers:
i) app_name - Type: String;
Return:
Token and session info;

accountUnRestriction DELETE PATCH PUT POST GET /accountUnRestriction

Request Body:

Loading...

Response:

POST
Functionality:Unrestrict an Account Restricted by the System;

Query Params:
i) email - Type:String ; Required

Accept: NA;

Headers:
i) authorization - Type: String;
Return:
blocked users;

Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.
Resources are listed in matching order. From top to bottom, the first URI to match the request is used.