This is an API that allows you to schedule the start and end of content publication.
You can also cancel any scheduled reservations that have been set.

Request Headers

X-MICROCMS-API-KEY

This is the authentication key required for requests to the Management API.
Please enable the default permission "Change Content Scheduling" for the Management API and include it in the request headers when sending.

Content-Type

Specify the format of the data to be sent.
Since microCMS only handles data in JSON format, please specify application/json.

Request Body

Please specify the publishTime and stopTime.

// When setting both publish time and stop time
// ※Existing publish start and end settings will be overwritten
{ "publishTime": "2026-01-13T06:31:24.668Z", "stopTime": "2026-01-14T06:31:24.668Z" }

// When setting only the publish time
// ※Existing publish end setting will be removed
{ "publishTime": "2026-01-13T06:31:24.668Z" }

// When setting only the stop time
// ※Existing publish start setting will be removed
{ "stopTime": "2026-01-14T06:31:24.668Z" }

// When removing existing publish start and end schedule settings
{}

Time Format

Specify as an ISO 8601 formatted date-time string.
Acceptable formats include the following:

• UTC (ending with Z)
  • Example: 2026-01-14T06:31:24.668Z
• UTC (without Z)
  • Example: 2026-01-14T06:31:24.668
  • If there is no Z, it will be interpreted as UTC (the example time is equivalent to 2026-01-14T06:31:24.668Z)
• With time zone (offset)
  • Example: 2026-01-14T15:31:24.668+09:00
  • The offset will be interpreted and registered as UTC (the above example will be treated as 2026-01-14T06:31:24.668Z)

Notes

• null / "" will result in an error.
• If there are existing publish start/end settings, they will be overwritten.
• If only one is specified in the request body, the schedule setting for the other will be removed.
• Sending an empty JSON object ({}) will remove the existing publish start and end schedule settings.

Response

Status Code

If the update is successful, a 200 response will be returned.

Response Body

If the update is successful, a response like the following will be returned.

{ "id": "some_content_id" }