scheduled_statuses

Schedule statuses for your instance to publish later.

get
View scheduled statuses

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

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

Request

Headers
Authorization
required
string
Bearer <user token>
Query Parameters
limit
optional
number
Max number of results to return. Defaults to 20.
max_id
optional
string
Return results older than ID
since_id
optional
string
Return results newer than ID
min_id
optional
string
Return results immediately newer than ID

Response

200: Success

[
  {
    "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: Unauthorized

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

get
View a single scheduled status

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

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

Request

Path Parameters
:id
required
string
ID of the scheduled status in the database.
Headers
Authorization
required
string
Bearer <user token>

Response

200: Success

{
  "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: Unauthorized

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

404: Not Found

{
  "error": "Record not found"
}

put
Schedule a status

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

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

Request

Path Parameters
:id
required
string
ID of the Status to be scheduled
Headers
Authorization
required
string
Bearer <user token>
Form Data Parameters
scheduled_at
optional
string
ISO 8601 Datetime at which the status will be published. Must be at least 5 minutes into the future.

Response

200: Success

{
  "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: Unauthorized

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

404: Not Found

{
  "error": "Record not found"
}

422: Unprocessable Entity

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

delete
Cancel a scheduled status

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

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

Request

Path Parameters
:id
required
string
ID of the scheduled status in the database.
Headers
Authorization
required
string
Bearer <user token>

Response

200: Success

{}

401: Unauthorized

Invalid or missing Authorization header

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

404: Not Found

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

{
  "error": "Record not found"
}

Last updated December 27, 2020 · Improve this page