Calendar
Pause or resume an automatic calendar
Pausing requires calendar:write. Resuming requires all of
calendar:write, articles:generate and articles:publish, because
resumed work may generate and publish. The server checks the requested
status and current calendar mode before accepting the command.
PATCH
/
profiles
/
{profile_id}
/
calendar
/
status
Error
A valid request URL is required to generate request examples{
"data": {
"calendar": {
"exists": false,
"profile_id": "22222222-2222-4222-8222-222222222222"
},
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}Authorizations
OAuth2PersonalAPIKey
Authorization-code grant with PKCE S256, exact scopes, explicit resource audience and a persisted consent grant. Obtain endpoint URLs from server discovery in the target environment. Refresh tokens remain client-bound.
FlowAuthorization Code
- Authorization URL
- /oauth/authorize
- Token URL
- /oauth/token
- Refresh URL
- /oauth/token
Scopes1
calendar:write
Manage calendar and slots.
Headers
Opaque client command key of 1 to 128 visible ASCII characters. UUID recommended; reuse only for the same command.
Required string length:
1 - 128Pattern:
^[!-~]+$Path Parameters
Profile UUID; must be in the grant allowlist and currently accessible to the actor.
Body
application/json
Available options:
paused, active ⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"calendar": {
"exists": false,
"profile_id": "22222222-2222-4222-8222-222222222222"
},
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}