set_domain_auto_renew
Turn Scheduler Zero's yearly renewal of a domain on or off.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## set_domain_auto_renew
Turn Scheduler Zero's yearly renewal of a domain on or off.
Use when a person asks to keep or let go of a domain at its next expiry; confirm first, because turning renewal on commits a future charge.
Turning renewal off lets the domain lapse at expiry; it does not transfer or cancel anything now.
Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.
Scopes: domain:purchase
Risk: costly; confirmation: explicit; idempotency: supported.
### Input schema (personal API key)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"autoRenew": {
"type": "boolean"
}
},
"required": [
"autoRenew"
],
"patternProperties": {
"^(?!(?:autoRenew)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"autoRenew"
]
}
]
}
}
},
"required": [
"workspaceId",
"domainId",
"request"
],
"patternProperties": {
"^(?!(?:workspaceId|domainId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"domainId",
"request"
]
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"domainId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"request": {
"type": "object",
"properties": {
"autoRenew": {
"type": "boolean"
}
},
"required": [
"autoRenew"
],
"patternProperties": {
"^(?!(?:autoRenew)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"autoRenew"
]
}
]
}
}
},
"required": [
"workspaceId",
"domainId",
"request"
],
"patternProperties": {
"^(?!(?:workspaceId|domainId|request)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"domainId",
"request"
]
}
}
```
### Output schema (structuredContent)
```json
{
"type": "object",
"properties": {
"autoRenew": {
"type": "boolean"
}
},
"required": [
"autoRenew"
],
"patternProperties": {
"^(?!(?:autoRenew)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"autoRenew"
]
}
]
}
}
```
### Underlying API operations
- `domains.setAutoRenew`: `POST /v1/workspaces/:workspaceId/domains/:domainId/auto-renew`
Scheduler Zero