POST Badge/ResetBadgeCount

Resets the badge count for a specific device token/handle

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DeviceToken	The device associated with these settings	string	Required

Request Formats

application/json, text/json

Sample:

{
  "DeviceToken": "sample string 1"
}

application/xml, text/xml

Sample:

<ResetBadgeCountViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CGI.MPulse.DeviceRegistration.Models">
  <DeviceToken>sample string 1</DeviceToken>
</ResetBadgeCountViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DeviceHandle

Name	Type	Additional information
DeviceToken	string	None.
IsActive	boolean	None.
UserId	string	None.
BadgeCount	integer	None.
LoginName	string	None.
Guid	string	None.
isDoNotDisturb	boolean	None.
DoNotDisturbStart	date	None.
DoNotDisturbEnd	date	None.
NotificationSetting	NotificationSettings	None.
System	string	None.
IsRegistrated	boolean	None.
TimeZoneInfo	string	None.
CreatedDate	date	None.
CreatedBy	string	None.
UpdatedDate	date	None.
UpdatedBy	string	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "DeviceToken": "sample string 1",
  "IsActive": true,
  "UserId": "sample string 3",
  "BadgeCount": 4,
  "LoginName": "sample string 5",
  "Guid": "sample string 6",
  "isDoNotDisturb": true,
  "DoNotDisturbStart": "2026-10-06T08:19:12.0878688+00:00",
  "DoNotDisturbEnd": "2026-10-06T08:19:12.0878688+00:00",
  "NotificationSetting": 0,
  "System": "sample string 8",
  "IsRegistrated": true,
  "TimeZoneInfo": "sample string 10",
  "CreatedDate": "2026-10-06T08:19:12.0878688+00:00",
  "CreatedBy": "sample string 12",
  "UpdatedDate": "2026-10-06T08:19:12.0878688+00:00",
  "UpdatedBy": "sample string 14",
  "Id": 15
}

application/xml, text/xml

Sample:

<DeviceHandle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CGI.MPulse.Domain.Models">
  <Id>15</Id>
  <CreatedBy>sample string 12</CreatedBy>
  <CreatedDate>2026-10-06T08:19:12.0878688+00:00</CreatedDate>
  <UpdatedBy>sample string 14</UpdatedBy>
  <UpdatedDate>2026-10-06T08:19:12.0878688+00:00</UpdatedDate>
  <BadgeCount>4</BadgeCount>
  <DeviceToken>sample string 1</DeviceToken>
  <DoNotDisturbEnd>2026-10-06T08:19:12.0878688+00:00</DoNotDisturbEnd>
  <DoNotDisturbStart>2026-10-06T08:19:12.0878688+00:00</DoNotDisturbStart>
  <Guid>sample string 6</Guid>
  <IsActive>true</IsActive>
  <IsRegistrated>true</IsRegistrated>
  <LoginName>sample string 5</LoginName>
  <NotificationSetting>None</NotificationSetting>
  <System>sample string 8</System>
  <TimeZoneInfo>sample string 10</TimeZoneInfo>
  <UserId>sample string 3</UserId>
  <isDoNotDisturb>true</isDoNotDisturb>
</DeviceHandle>