Create a scheduled post

Create a new scheduled post for the authenticated user

POST /api/v1/posts/schedule

Create a scheduled post

cURL

curl --request POST \
  --url https://apix.us.amity.co/api/v1/posts/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scheduledAt": "2025-08-15T10:00:00Z",
  "postData": {
    "data": {
      "title": "<string>",
      "text": "example text",
      "fileId": "57b916d38eaf8010caddfb7759a2d06c",
      "pollId": "53a9fd8b5aaa1af6c5a1bbd245ce4a9b1627373735551",
      "streamId": "81559bcc3a5bb3b6bbd69a83b89d337e",
      "roomId": "<string>"
    },
    "attachments": [
      {
        "fileId": "57b916d38eaf8010caddfb7759a2d06c",
        "displayMode": "fit",
        "isMuted": false
      }
    ],
    "dataType": "upstra.customtype",
    "targetType": "user",
    "targetId": "public_user_id",
    "metadata": {
      "anything": "you want"
    },
    "links": [
      {
        "url": "<string>",
        "index": 1,
        "length": 2,
        "renderPreview": false,
        "domain": "<string>",
        "title": "<string>",
        "imageUrl": "<string>"
      }
    ],
    "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",
    "isDiscoverable": true,
    "eventId": "507f1f77bcf86cd799439011"
  }
}
'

201

{
  "data": {
    "id": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

scheduledAt · string<date-time> · required

When the post should be published

Example:

"2025-08-15T10:00:00Z"

postData · object · required

Show child attributes

Response

201

application/json

Scheduled post created successfully

data · object

Show child attributes