scheduled_statuses API methods
Manage statuses that were scheduled to be published at a future date.
View scheduled statuses
GET /api/v1/scheduled_statuses HTTP/1.1
Returns: Array of ScheduledStatus
OAuth: User token + read:statuses
Version history:
2.7.0 - added
3.3.0 - both min_id
and max_id
can be used at the same time now
Request
Headers
- Authorization
- required Provide this header with
Bearer <user token>
to gain authorized access to this API method.
Query parameters
- 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.
- limit
- Integer. Maximum number of results to return. Defaults to 20 statuses. Max 40 statuses.
Response
200: OK
[
{
"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
Invalid or missing Authorization header.
{
"error": "The access token is invalid"
}
View a single scheduled status
GET /api/v1/scheduled_statuses/:id HTTP/1.1
Returns: ScheduledStatus
OAuth: User token + read:statuses
Version history:
2.7.0 - added
Request
Path parameters
- :id
- required String. The ID of the ScheduledStatus in the database.
Headers
- Authorization
- required Provide this header with
Bearer <user token>
to gain authorized access to this API method.
Response
200: OK
{
"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
Invalid or missing Authorization header.
{
"error": "The access token is invalid"
}
404: Not found
ScheduledStatus is not owned by you or does not exist
{
"error": "Record not found"
}
Update a scheduled status’s publishing date
PUT /api/v1/scheduled_statuses/:id HTTP/1.1
Returns: ScheduledStatus
OAuth: User token + write:statuses
Version history:
2.7.0 - added
Request
Path parameters
- :id
- required String. The ID of the ScheduledStatus in the database.
Headers
- Authorization
- required Provide this header with
Bearer <user token>
to gain authorized access to this API method.
Form data parameters
- scheduled_at
- String. ISO 8601 Datetime at which the status will be published. Must be at least 5 minutes into the future.
Response
200: OK
{
"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
Invalid or missing Authorization header.
{
"error": "The access token is invalid"
}
404: Not found
ScheduledStatus is not owned by you or does not exist
{
"error": "Record not found"
}
422: Unprocessable entity
{
"error": "Validation failed: Scheduled at The scheduled date must be in the future"
}
Cancel a scheduled status
DELETE /api/v1/scheduled_statuses/:id HTTP/1.1
Returns: empty object
OAuth: User token + write:statuses
Version history:
2.7.0 - added
Request
Path parameters
- :id
- required String. The ID of the ScheduledStatus in the database.
Headers
- Authorization
- required Provide this header with
Bearer <user token>
to gain authorized access to this API method.
Response
200: OK
{}
401: Unauthorized
Invalid or missing Authorization header.
{
"error": "The access token is invalid"
}
404: Not found
ScheduledStatus is not owned by you or does not exist
{
"error": "Record not found"
}
See also
scheduled_at
parameter)
POST /api/v1/statuses ( app/controllers/api/v1/scheduled_statuses_controller.rbLast updated February 6, 2023 路 Improve this page