scheduled_statuses

Schedule statuses for your instance to publish later.

View scheduled statuses

GET https://mastodon.example/api/v1/scheduled_statuses

Returns: Array of ScheduledStatus OAuth: User token + read:statuses Version history: 2.7.0 - added

Query Parameters

Name	Type	Description
limit	number	Max number of results to return. Defaults to 20.
max_id	string	Return results older than ID
since_id	string	Return results newer than ID
min_id	string	Return results immediately newer than ID

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

200

[
  {
    "id": "3221",
    "scheduled_at": "2019-12-05T12:33:01.000Z",
    "params": {
      "poll": null,
      "text": "test content",
      "media_ids": null,
      "sensitive": null,
      "visibility": null,
      "idempotency": null,
      "scheduled_at": null,
      "spoiler_text": null,
      "application_id": 596551,
      "in_reply_to_id": null
    },
    "media_attachments": []
  }
]

401

{
  "error": "The access token is invalid"
}

View a single scheduled status

GET https://mastodon.example/api/v1/scheduled_statuses/:id

Returns: ScheduledStatus OAuth: User token + read:statuses Version history: 2.7.0 - added

Path Parameters

Name	Type	Description
:id	string	ID of the scheduled status in the database.

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

200

{
  "id": "3221",
  "scheduled_at": "2019-12-05T12:33:01.000Z",
  "params": {
    "poll": null,
    "text": "test content",
    "media_ids": null,
    "sensitive": null,
    "visibility": null,
    "idempotency": null,
    "scheduled_at": null,
    "spoiler_text": null,
    "application_id": 596551,
    "in_reply_to_id": null
  },
  "media_attachments": []
}

401

{
  "error": "The access token is invalid"
}

404

{
  "error": "Record not found"
}

Schedule a status

PUT https://mastodon.example/api/v1/scheduled_statuses/:id

Returns: ScheduledStatus OAuth: User token + write:statuses Version history: 2.7.0 - added

Path Parameters

Name	Type	Description
:id	string	ID of the Status to be scheduled

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

Request Body

Name	Type	Description
scheduled_at	string	ISO 8601 Datetime at which the status will be published. Must be at least 5 minutes into the future.

200

{
  "id": "3221",
  "scheduled_at": "2019-12-05T13:33:01.000Z",
  "params": {
    "poll": null,
    "text": "test content",
    "media_ids": null,
    "sensitive": null,
    "visibility": null,
    "idempotency": null,
    "scheduled_at": null,
    "spoiler_text": null,
    "application_id": 596551,
    "in_reply_to_id": null
  },
  "media_attachments": []
}

401

{
  "error": "The access token is invalid"
}

404

{
  "error": "Record not found"
}

422

{
  "error": "Validation failed: Scheduled at The scheduled date must be in the future"
}

Cancel a scheduled status

DELETE https://mastodon.example/api/v1/scheduled_statuses/:id

Returns: empty object OAuth: User token + write:statuses Version history: 2.7.0 - added

Path Parameters

Name	Type	Description
:id	string	ID of the scheduled status in the database.

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

200

{}

401 Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

404 No ScheduledStatus at that id, or you do not own it

{
  "error": "Record not found"
}