@@ -13,47 +13,41 @@ ms.reviewer:
1313
1414## SYNOPSIS
1515
16- Retrieves the IsCopilotPromoStatusEnabled ( "true/false" ) state of the Copilot promo opt-in bit and stores the information .
16+ Sets the Opt-In Copilot promo status for the tenant .
1717
1818## SYNTAX
1919``` powershell
20- Set-SPOCopilotPromoOptInStatus
20+ Set-SPOCopilotPromoOptInStatus -IsCopilotPromoStatusEnabled $true
2121```
22-
23- ### Parameters:
24-
25- The following details are returned:
26-
27- - Copilot promo status set successfully, returns nothing if successful.
28-
29- - Copilot promo status set failed, returns an error.
30-
3122## DESCRIPTION
3223
33- The ` Set-SPOCopilotPromoOptInStatus ` cmdlet stores the opt-in state. The user must be a SharePoint Admin to run the cmlets.
34-
24+ This cmdlet sets the Opt-In Copilot promo status for the tenant to ` True ` or ` False ` . The user must be a SharePoint Admin to run the cmlets.
3525
3626## EXAMPLES
3727
3828### Example 1
3929
4030``` powershell
41- Set-SPOCopilotPromoOptInStatusSetSuccessfully -SPOCopilotPromoOptInStatusEnabled true
31+ Set-SPOCopilotPromoOptInStatusSetSuccessfully -SPOCopilotPromoOptInStatusEnabled $ true
4232```
4333
44- Example 1: No success message returned, can validate by executing Get-SPOCopilotPromoOptInStatus.
45- If commandlet fails to execute for Set-CopilotPromoOptInStatus, an error message is shown to user.
34+ Example 1 sets the Opt-In Copilot promo status for the tenant to ` True ` .
4635
47- ### Example 2
36+ ### Parameter:
4837
49- ``` powershell
50- Set-SPOCopilotPromoOptInStatusSetSuccessfully -SPOCopilotPromoOptInStatusDisabled false
51- ```
38+ ### -IsCopilotPromoStatusEnabled
5239
53- Example 2: Success message shown to user when commandlet executes successfully for Set-CopilotPromoOptInStatus
54- If commandlet fails to execute for Set-CopilotPromoOptInStatus, an error message is shown to user.
40+ Use this parameter to set Copilot opt-in promo status.
5541
42+ ``` yaml
43+ Type : boolean
44+ Parameter Sets :
45+ Aliases :
46+ Applicable : SharePoint Online
5647
48+ Required : True
49+ Default value : None
50+ ` ` `
5751## RELATED LINKS
58-
59- Get-SPOCopilotPromoOptInStatus
52+ - [Get-SPOCopilotPromoOptInStatus](./Get-SPOCopilotPromoOptInStatus.md)
53+ - [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
0 commit comments