scheduled_freeze

Update a scheduled freeze

Changed on

Update an existing scheduled freeze on the repository specified in the path. Only the fields provided in the request body will be updated.

patch/repos/{owner}/{repository}/scheduled_freeze/{freeze_id}

Request

  • Base URL: https://api.mergify.com/v1
  • URL: https://api.mergify.com/v1/repos/{owner}/{repository}/scheduled_freeze/{freeze_id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

freeze_idstring uuid required

The scheduled freeze id

repositorystring required

The name of the repository

ownerstring required

The owner of the repository

Request body

reasonstring nullable

The reason for the scheduled freeze.

startstring date-time nullable

When the scheduled freeze begins (date and time in ISO 8601 format without TZ). Can only be updated if the scheduled freeze has not yet begun. Set to null to start now.

endstring date-time nullable

When the scheduled freeze ends (date and time in ISO 8601 format without TZ). Set to null for an indefinite freeze.

timezonestring nullable

Timezone where the freeze is expected to happen.

Response

Successful Response

idstring uuid required
reasonstring required
startstring date-time required
endstring date-time nullable required
timezonestring required

Changes

  • b3864dcc206aRevision changes
    • info

      the endpoint scheme security MergifyTokenBearerAuth was added to the API

  • 29857c6146cfRevision changes
    • info

      the endpoint scheme security AdminApplicationKey was added to the API

    • info

      the endpoint scheme security ApplicationAuth was removed from the API