---
updatedAt: 2026-06-25T22:44:00.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# Update schedule

Update account schedule by schedule ID.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Core platform - Payment scheduler",
    "version": "1.0.0",
    "description": "Endpoints to enable scheduler creation and processing.",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/scheduler-payments",
      "description": "Sandbox API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Schedules",
      "description": "Endpoints to enable scheduler creation and processing"
    }
  ],
  "components": {
    "responses": {
      "204NoContent": {
        "description": "No content"
      },
      "400BadRequest": {
        "description": "Bad request"
      },
      "403Forbidden": {
        "description": "Operation forbidden"
      },
      "404NotFound": {
        "description": "The specified resource was not found"
      },
      "500InternalServer": {
        "description": "Internal server error"
      }
    },
    "parameters": {
      "accountId": {
        "in": "path",
        "name": "accountId",
        "schema": {
          "type": "integer",
          "format": "int64"
        },
        "description": "Pismo account ID",
        "required": true
      },
      "scheduleId": {
        "in": "path",
        "name": "scheduleId",
        "schema": {
          "type": "string"
        },
        "description": "Schedule ID",
        "required": true
      }
    },
    "schemas": {
      "Amount": {
        "type": "number",
        "format": "float",
        "description": "Credit or debit amount",
        "example": 100.23
      },
      "CurrencyCode": {
        "type": "string",
        "description": "Three-letter currency code of the operation in ISO 4217.",
        "example": "BRL"
      },
      "Description": {
        "type": "string",
        "description": "Optional text that describes the operation",
        "example": "Custom purchase",
        "maxLength": 100
      },
      "EndDate": {
        "type": "string",
        "format": "date-time",
        "description": "End date of schedule executions in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.\n",
        "example": "2023-01-02T07:00:00.000Z"
      },
      "IntervalRecurrence": {
        "type": "integer",
        "description": "Interval for retries, in minutes",
        "minimum": 1,
        "maximum": 60,
        "example": 5
      },
      "Metadata": {
        "type": "object",
        "description": "This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. The Pismo platform does not perform any validation or processing on this field.\n\n**Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).\n",
        "example": {
          "any-key": "any-value"
        }
      },
      "NumberOfAttempts": {
        "type": "integer",
        "description": "Maximum number of execution retries",
        "minimum": 1,
        "maximum": 10,
        "example": 5
      },
      "PreScheduleDetails": {
        "type": "object",
        "description": "Pre-schedule details",
        "properties": {
          "statement": {
            "$ref": "#/components/schemas/Statement"
          }
        }
      },
      "ProcessingCode": {
        "type": "string",
        "description": "Processing code that identifies the credit or debit operation",
        "example": "219803"
      },
      "Restrictions": {
        "type": "object",
        "description": "Restrictions applied to the schedule",
        "properties": {
          "minimum_daily_available": {
            "type": "number",
            "format": "float",
            "description": "Establishes a minimum limit value to always be maintained in the customer's balance. If the value of the customer's balance is lower than the minimum limit value, the schedule is executed, otherwise its execution is stopped and saved as \"Executed with restrictions\".\n",
            "example": 100.23
          },
          "minimum_monthly_average_available": {
            "type": "number",
            "format": "float",
            "description": "Follows the same logic as `minimum_daily_available`, except it considers an average limit value from the first day of the month until the day before the scheduled execution to compare with the customer’s balance value.\n",
            "example": 100.23
          },
          "minimum_days_account_inactivity": {
            "type": "integer",
            "description": "If the days of account inactivity are greater than this field value, the schedule execution is stopped and saved as \"Executed with restrictions\".\n",
            "example": 5
          }
        }
      },
      "Retries": {
        "type": "object",
        "description": "Configuration to define retry policy for failed executions.",
        "properties": {
          "interval_recurrence": {
            "$ref": "#/components/schemas/IntervalRecurrence"
          },
          "number_of_attempts": {
            "$ref": "#/components/schemas/NumberOfAttempts"
          }
        }
      },
      "Statement": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Pismo ID of the statement linked to the pre-schedule",
            "example": 1234455
          }
        }
      },
      "UpdateSchedulerRequest": {
        "type": "object",
        "description": "Request to update an existing schedule",
        "properties": {
          "single": {
            "type": "object",
            "description": "Single schedule object",
            "properties": {
              "description": {
                "$ref": "#/components/schemas/Description"
              },
              "metadata": {
                "$ref": "#/components/schemas/Metadata"
              },
              "restrictions": {
                "$ref": "#/components/schemas/Restrictions"
              },
              "schedule_details": {
                "type": "object",
                "description": "Schedule details",
                "properties": {
                  "end_date": {
                    "$ref": "#/components/schemas/EndDate"
                  },
                  "retries": {
                    "$ref": "#/components/schemas/Retries"
                  }
                }
              }
            }
          },
          "pre": {
            "type": "object",
            "description": "Pre-schedule object",
            "properties": {
              "schedule_details": {
                "$ref": "#/components/schemas/PreScheduleDetails"
              },
              "processing_code": {
                "$ref": "#/components/schemas/ProcessingCode"
              },
              "amount": {
                "$ref": "#/components/schemas/Amount"
              },
              "currency_code": {
                "$ref": "#/components/schemas/CurrencyCode"
              },
              "description": {
                "$ref": "#/components/schemas/Description"
              },
              "metadata": {
                "$ref": "#/components/schemas/Metadata"
              }
            }
          },
          "transfer": {
            "type": "object",
            "description": "Transfer schedule object",
            "properties": {
              "description": {
                "$ref": "#/components/schemas/Description"
              },
              "metadata": {
                "$ref": "#/components/schemas/Metadata"
              },
              "schedule_details": {
                "type": "object",
                "description": "Schedule details",
                "properties": {
                  "end_date": {
                    "$ref": "#/components/schemas/EndDate"
                  }
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/v1/accounts/{accountId}/schedules/{scheduleId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/accountId"
        },
        {
          "$ref": "#/components/parameters/scheduleId"
        }
      ],
      "patch": {
        "summary": "Update schedule",
        "description": "Update account schedule by schedule ID.\n",
        "operationId": "patch-schedule",
        "tags": [
          "Schedules"
        ],
        "requestBody": {
          "description": "Request processing body",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateSchedulerRequest"
              }
            }
          }
        },
        "responses": {
          "204": {
            "$ref": "#/components/responses/204NoContent"
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "403": {
            "$ref": "#/components/responses/403Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/404NotFound"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServer"
          }
        }
      }
    }
  }
}
```