Skip to main content
POST
/
api
/
v1
/
pinned-posts
/
global
/
{postId}
Global pin a post in a global feed
curl --request POST \
  --url https://apix.us.amity.co/api/v1/pinned-posts/global/{postId} \
  --header 'Authorization: Bearer <token>'
{ "pinTargets": [ { "targetId": "<string>", "targetType": "<string>", "lastPinsUpdatedAt": "2023-11-07T05:31:56Z" } ], "pins": [ { "referenceId": "<string>", "referenceType": "<string>", "placement": "<string>", "pinnedBy": "<string>", "pinnedAt": "2023-11-07T05:31:56Z" } ], "posts": [ { "postId": "<string>", "data": { "title": "<string>", "text": "<string>", "fileId": "<string>", "thumbnailFileId": "<string>", "videoFileId": { "original": "<string>", "low": "<string>", "medium": "<string>", "high": "<string>" }, "streamId": "<string>" }, "_id": "<string>", "path": "<string>", "parentPostId": "<string>", "postedUserId": "<string>", "postedUserPublicId": "<string>", "postedUserInternalId": "<string>", "sharedUserId": "<string>", "sharedCount": 123, "targetId": "<string>", "targetPublicId": "<string>", "targetInternalId": "<string>", "targetType": "user", "dataType": "text", "metadata": {}, "flagCount": 123, "hashFlag": { "bits": 123, "hashes": 123, "hash": [ "<string>" ] }, "editedAt": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "reactions": { "like": 1 }, "reactionsCount": 1, "myReactions": [ "like" ], "commentsCount": 1, "comments": [ "<string>" ], "children": [ "<string>" ], "childrenNumber": 123, "isDeleted": false, "hasFlaggedComment": false, "hasFlaggedChildren": false, "feedId": "<string>", "tags": [ "<string>" ], "hashtags": [ "technology", "programming", "web_development", "JavaScript", "AI_trends" ], "mentionees": [ { "type": "user", "userIds": [ "<string>" ], "userPublicIds": [ "<string>" ], "userInternalIds": [ "<string>" ] } ], "impression": 123, "reach": 123, "structureType": "text" } ], "postChildren": [ { "postId": "<string>", "data": { "title": "<string>", "text": "<string>", "fileId": "<string>", "thumbnailFileId": "<string>", "videoFileId": { "original": "<string>", "low": "<string>", "medium": "<string>", "high": "<string>" }, "streamId": "<string>" }, "_id": "<string>", "path": "<string>", "parentPostId": "<string>", "postedUserId": "<string>", "postedUserPublicId": "<string>", "postedUserInternalId": "<string>", "sharedUserId": "<string>", "sharedCount": 123, "targetId": "<string>", "targetPublicId": "<string>", "targetInternalId": "<string>", "targetType": "user", "dataType": "text", "metadata": {}, "flagCount": 123, "hashFlag": { "bits": 123, "hashes": 123, "hash": [ "<string>" ] }, "editedAt": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "reactions": { "like": 1 }, "reactionsCount": 1, "myReactions": [ "like" ], "commentsCount": 1, "comments": [ "<string>" ], "children": [ "<string>" ], "childrenNumber": 123, "isDeleted": false, "hasFlaggedComment": false, "hasFlaggedChildren": false, "feedId": "<string>", "tags": [ "<string>" ], "hashtags": [ "technology", "programming", "web_development", "JavaScript", "AI_trends" ], "mentionees": [ { "type": "user", "userIds": [ "<string>" ], "userPublicIds": [ "<string>" ], "userInternalIds": [ "<string>" ] } ], "impression": 123, "reach": 123, "structureType": "text" } ], "comments": [ { "commentId": "<string>", "_id": "<string>", "path": "<string>", "userId": "<string>", "userPublicId": "<string>", "userInternalId": "<string>", "parentId": "<string>", "rootId": "<string>", "referenceId": "<string>", "referenceType": "post", "dataType": "<string>", "dataTypes": [ "text" ], "data": {}, "metadata": {}, "childrenNumber": 123, "flagCount": 123, "hashFlag": { "bits": 123, "hashes": 123, "hash": [ "<string>" ] }, "reactions": { "like": 1 }, "reactionsCount": 1, "myReactions": [ "like" ], "isDeleted": false, "editedAt": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "children": [ "<string>" ], "segmentNumber": 1, "mentionees": [ { "type": "user", "userIds": [ "<string>" ], "userPublicIds": [ "<string>" ], "userInternalIds": [ "<string>" ] } ], "attachments": [ { "type": "image", "fileId": "<string>" } ], "targetId": "<string>", "targetType": "community" } ], "users": [ { "userId": "<string>", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "_id": "<string>", "path": "<string>", "userInternalId": "<string>", "userPublicId": "<string>", "roles": [ "<string>" ], "permissions": [ "MUTE_CHANNEL" ], "displayName": "<string>", "profileHandle": "<string>", "description": "<string>", "avatarFileId": "<string>", "avatarCustomUrl": "<string>", "flagCount": 123, "hashFlag": { "bits": 123, "hashes": 123, "hash": [ "<string>" ] }, "metadata": {}, "isGlobalBan": true, "isBrand": true, "isDeleted": true } ], "files": [ { "fileId": "<string>", "fileUrl": "<string>", "type": "image", "accessType": "public", "altText": "<string>", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "attributes": { "name": "<string>", "extension": "<string>", "size": 123, "mimeType": "<string>", "metadata": { "exif": {}, "gps": {}, "height": 123, "width": 123, "isFull": true } } } ], "communities": [ { "communityId": "<string>", "channelId": "<string>", "displayName": "<string>", "_id": "<string>", "path": "<string>", "userId": "<string>", "userPublicId": "<string>", "userInternalId": "<string>", "avatarFileId": "<string>", "description": "<string>", "isOfficial": true, "isPublic": true, "onlyAdminCanPost": true, "tags": [ "<string>" ], "metadata": {}, "postsCount": 123, "membersCount": 123, "isJoined": true, "categoryIds": [ "<string>" ], "isDeleted": false, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "hasFlaggedComment": false, "hasFlaggedPost": false, "needApprovalOnPostCreation": false, "moderatorMemberCount": 123, "allowCommentInStory": true, "isDiscoverable": false, "requiresJoinApproval": false, "notificationMode": "default", "type": "default" } ], "communityUsers": [ { "userId": "<string>", "userPublicId": "<string>", "userInternalId": "<string>", "channelId": "<string>", "communityId": "<string>", "communityMembership": "none", "notMemberReason": "<string>", "isBanned": false, "lastActivity": "2023-11-07T05:31:56Z", "roles": [ "<string>" ], "permissions": [ "MUTE_CHANNEL" ], "lastJoin": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z" } ], "categories": [ { "categoryId": "<string>", "name": "<string>", "metadata": {}, "avatarFileId": "<string>", "isDeleted": false, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z" } ], "feeds": [ { "targetId": "<string>", "targetType": "community", "postCount": 123, "feedType": "published", "feedId": "<string>", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z" } ], "videoStreamings": [ { "streamId": "<string>", "userId": "<string>", "userInternalId": "64be1f6cb9b4106b5a6bbf3f", "userPublicId": "User123", "thumbnailFileId": "<string>", "title": "<string>", "status": "idle", "isLive": true, "isDeleted": true, "description": "<string>", "platform": { "name": "<string>", "version": "<string>" }, "moderationId": "<string>", "startedAt": "2023-11-07T05:31:56Z", "endedAt": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "metadata": {}, "resolution": "SD", "streamerUrl": { "url": "<string>", "components": { "origin": "<string>", "appName": "<string>", "streamName": "<string>", "query": "<string>" } }, "recordings": [ { "flv": { "url": "<string>", "duration": 123, "startTime": 123, "stopTime": 123 }, "mp4": { "url": "<string>", "duration": 123, "startTime": 123, "stopTime": 123 }, "m3u8": { "url": "<string>", "duration": 123, "startTime": 123, "stopTime": 123 } } ], "watcherUrl": { "flv": { "url": "<string>", "components": { "origin": "<string>", "appName": "<string>", "streamName": "<string>", "query": "<string>" } }, "hls": { "url": "<string>", "components": { "origin": "<string>", "appName": "<string>", "streamName": "<string>", "query": "<string>" } }, "rtmp": { "url": "<string>", "components": { "origin": "<string>", "appName": "<string>", "streamName": "<string>", "query": "<string>" } } }, "postId": "<string>", "channelId": "<string>", "channelEnabled": true, "isParent": false, "parentStreamId": "<string>", "childStreamIds": [] } ], "polls": [ { "pollId": "<string>", "userId": "<string>", "userInternalId": "64be1f6cb9b4106b5a6bbf3f", "userPublicId": "User123", "title": "<string>", "question": "<string>", "answers": [ { "dataType": "text", "data": "<string>", "fileId": "<string>", "voteCount": 0, "isVotedByUser": false, "id": "<string>" } ], "answerType": "<string>", "closedAt": "<string>", "createdAt": "<string>", "isVoted": false, "status": "open", "closedIn": 123 } ] }

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
postId
string
required
Maximum string length: 900

Response

Pin Post Information

​
pinTargets
object[]
​
pins
object[]
​
posts
object[]
​
postChildren
object[]
​
comments
object[]
​
users
object[]
​
files
object[]
​
communities
object[]
​
communityUsers
object[]
​
categories
object[]
​
feeds
object[]
​
videoStreamings
object[]
​
polls
object[]