Set-CustomNudge

This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see About the Exchange Online PowerShell V2 module.

Note: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature.

Use the Set-CustomNudge cmdlet to modify Custom Nudges that are displayed in user Briefing email messages.

For information about the parameter Sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Set-CustomNudge
   -Name <String>
   [-Content <String>]
   [-From <String>]
   [-ResultSize <Unlimited>]
   [-Title <String>]
   [<CommonParameters>]

Description

This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following roles in Azure Active Directory:

  • Global Administrator
  • Exchange Administrator
  • Insights Administrator

To learn more about administrator role permissions in Azure Active Directory, see Azure AD built-in roles.

Examples

Example 1

Set-CustomNudge -Name perfReviewNudge -From "Microsoft HR" -Title "Please complete your performance reviews ASAP" -Content "They are very important to help your colleagues grow professionally."

This example updates an existing Custom Nudge named "perfReviewNudge" with the specified From, Title, and Content values.

Parameters

-Content

The Content parameter specifies the text that appears below the Custom Nudge title in the Briefing email. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks (").

To include hyperlinks, use the markdown format. For example, [Contoso](https://www.contoso.com).

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-From

The From parameter specifies the creator of the Custom Nudge. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").

Typically, this value is the name of the company or department that's responsible for the Custom Nudge.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Name

The Name parameter specifies a unique name for Custom Nudge. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks (").

This value is not shown to users.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ResultSize

This parameter is reserved for internal Microsoft use.

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Title

The Title parameter specifies the bold title of the Custom Nudge that's displayed in the Briefing email. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks (").

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online