Move NotionDatabaseToArchive

---

Category: Commands external help file: Notion-help.xml Module Name: Notion online version: https://developers.notion.com/reference/update-a-database (archive=true) schema: 2.0.0 Type: Command

Move-NotionDatabaseToArchive

SYNOPSIS

Moves a Notion database to the archive.

SYNTAX

Move-NotionDatabaseToArchive [-DatabaseId] <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

The Move-NotionDatabaseToArchive function archives a specified Notion database by setting its archive property to true. This operation is confirmed by the user due to its high impact.

EXAMPLES

EXAMPLE 1

Move-NotionDatabaseToArchive -DatabaseId "12345"
This command archives the Notion database with the ID "12345".

PARAMETERS

-DatabaseId

The ID of the database to archive. This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases: Id

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

[string]

OUTPUTS

[notion_database]

NOTES

This function uses the Invoke-NotionApiCall cmdlet to make a PATCH request to the Notion API. Attention: Only pages can be restored via the GUI. Databases can only be restored via the API.

RELATED LINKS

https://developers.notion.com/reference/update-a-database (archive=true)

https://developers.notion.com/reference/update-a-database (archive=true)