PUT
/
api
/
v1
/
posts
/
schedule
/
{id}
Update a scheduled post
curl --request PUT \
  --url https://apix.us.amity.co/api/v1/posts/schedule/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scheduledAt": "2023-11-07T05:31:56Z",
  "postData": {
    "data": {
      "title": "<string>",
      "text": "example text",
      "streamId": "81559bcc3a5bb3b6bbd69a83b89d337e",
      "pollId": "53a9fd8b5aaa1af6c5a1bbd245ce4a9b1627373735551"
    },
    "attachments": [
      {
        "fileId": "57b916d38eaf8010caddfb7759a2d06c",
        "type": "image",
        "displayMode": "fill",
        "isMuted": "true"
      }
    ],
    "dataType": "upstra.customtype",
    "targetType": "user",
    "targetId": "public_user_id",
    "metadata": {
      "anything": "you want"
    },
    "postId": "postidiwant",
    "tags": [
      "<string>"
    ],
    "hashtags": [
      "tech_news",
      "startup_life",
      "product_launch",
      "innovation_2025"
    ],
    "mentionees": [
      {
        "type": "user",
        "userIds": [
          "userId1",
          "userId2"
        ]
      }
    ],
    "createdAt": "2022-07-07T04:24:20.444Z"
  }
}'
{
  "data": [
    {
      "_id": "<string>",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "status": {
        "code": "WAIT",
        "description": "<string>"
      },
      "postData": {
        "_id": "<string>",
        "path": "<string>",
        "postId": "<string>",
        "parentPostId": "<string>",
        "postedUserId": "<string>",
        "postedUserPublicId": "<string>",
        "postedUserInternalId": "<string>",
        "publisherId": "<string>",
        "publisherPublicId": "<string>",
        "sharedUserId": "<string>",
        "sharedCount": 123,
        "targetId": "<string>",
        "targetPublicId": "<string>",
        "targetInternalId": "<string>",
        "targetType": "user",
        "dataType": "text",
        "data": {
          "title": "<string>",
          "text": "<string>",
          "fileId": "<string>",
          "thumbnailFileId": "<string>",
          "videoFileId": {
            "original": "<string>",
            "low": "<string>",
            "medium": "<string>",
            "high": "<string>"
          },
          "streamId": "<string>"
        },
        "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": [
          "video_content",
          "clips_feature",
          "multimedia_posts",
          "next_gen_social"
        ],
        "mentionees": [
          {
            "type": "user",
            "userIds": [
              "<string>"
            ],
            "userPublicIds": [
              "<string>"
            ],
            "userInternalIds": [
              "<string>"
            ]
          }
        ],
        "impression": 123,
        "reach": 123
      },
      "userId": "<string>",
      "userDisplayName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "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": [
        {
          "_id": "<string>",
          "path": "<string>",
          "communityId": "<string>",
          "channelId": "<string>",
          "userId": "<string>",
          "userPublicId": "<string>",
          "userInternalId": "<string>",
          "displayName": "<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"
        }
      ]
    }
  ],
  "networkId": "<string>",
  "paging": {
    "next": "<string>",
    "prev": "<string>"
  },
  "users": [
    {
      "_id": "<string>",
      "path": "<string>",
      "userId": "<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,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "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": [
    {
      "_id": "<string>",
      "path": "<string>",
      "communityId": "<string>",
      "channelId": "<string>",
      "userId": "<string>",
      "userPublicId": "<string>",
      "userInternalId": "<string>",
      "displayName": "<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"
    }
  ],
  "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

id
string
required

Scheduled post ID

Body

application/json
scheduledAt
string<date-time>

Updated schedule time

postData
object

Response

Scheduled post updated successfully

data
object[]
networkId
string
paging
object
users
object[]
files
object[]
communities
object[]
polls
object[]