PUT api/pinches/{pinchId}/notification

Update a Pinch's notification settings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pinchId

globally unique identifier

Required

Body Parameters

PinchNotificationDto
NameDescriptionTypeAdditional information
BubbleImageUrl

string

None.

ShowBubble

boolean

None.

BarImageUrl

string

None.

OpenOnAppLaunch

boolean

None.

OpenFromNotificationCenter

boolean

None.

OpenOnAppRunning

boolean

None.

BubbleIconId

integer

None.

BubbleTitleNo

string

None.

BubbleTitleEn

string

None.

NotificationTextNo

string

None.

NotificationTextEn

string

None.

NotificationTitleNo

string

None.

NotificationTitleEn

string

None.

TriggerNotification

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BubbleImageUrl": "sample string 1",
  "ShowBubble": true,
  "BarImageUrl": "sample string 3",
  "OpenOnAppLaunch": true,
  "OpenFromNotificationCenter": true,
  "OpenOnAppRunning": true,
  "BubbleIconId": 1,
  "BubbleTitleNo": "sample string 7",
  "BubbleTitleEn": "sample string 8",
  "NotificationTextNo": "sample string 9",
  "NotificationTextEn": "sample string 10",
  "NotificationTitleNo": "sample string 11",
  "NotificationTitleEn": "sample string 12",
  "TriggerNotification": "sample string 13"
}

Response Information

Resource Description

PinchDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

None.

Description

string

None.

ExpirationPeriod

string

None.

UserLimit

integer

None.

AppTimeLimitHours

integer

None.

ValidFrom

date

None.

ValidTo

date

None.

Status

PinchStatusEnum

None.

CustomerGroup

NamedItem

None.

Customer

NamedItem

None.

App

AppSimpleDto

None.

DailySchedule

Schedule

None.

IsActive

boolean

None.

Tags

Collection of string

None.

PublishId

globally unique identifier

None.

NotificationSettings

PinchNotificationDto

None.

MessageSettings

PinchMessageSettingsDto

None.

ModifiedDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "4eefb29b-85ff-496a-80dc-9d688e33451e",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ExpirationPeriod": "sample string 4",
  "UserLimit": 5,
  "AppTimeLimitHours": 6,
  "ValidFrom": "2024-10-01T13:37:45.3669782+00:00",
  "ValidTo": "2024-10-01T13:37:45.3669782+00:00",
  "Status": "Draft",
  "CustomerGroup": {
    "Id": "2294716d-41db-4bd2-9765-88b6ed5c0c0a",
    "Name": "sample string 2"
  },
  "Customer": {
    "Id": "2294716d-41db-4bd2-9765-88b6ed5c0c0a",
    "Name": "sample string 2"
  },
  "App": {
    "NotificationType": "Bubble",
    "Id": "c79910a8-87b9-44f0-957e-bdb483220f4f",
    "Name": "sample string 2"
  },
  "DailySchedule": {
    "From": "sample string 1",
    "To": "sample string 2"
  },
  "IsActive": true,
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "PublishId": "fc4ba155-b461-4417-a9a1-a52c6616d29d",
  "NotificationSettings": {
    "BubbleImageUrl": "sample string 1",
    "ShowBubble": true,
    "BarImageUrl": "sample string 3",
    "OpenOnAppLaunch": true,
    "OpenFromNotificationCenter": true,
    "OpenOnAppRunning": true,
    "BubbleIconId": 1,
    "BubbleTitleNo": "sample string 7",
    "BubbleTitleEn": "sample string 8",
    "NotificationTextNo": "sample string 9",
    "NotificationTextEn": "sample string 10",
    "NotificationTitleNo": "sample string 11",
    "NotificationTitleEn": "sample string 12",
    "TriggerNotification": "sample string 13"
  },
  "MessageSettings": {
    "MessageTitleNo": "sample string 1",
    "MessageTitleEn": "sample string 2",
    "MessageTextNo": "sample string 3",
    "MessageTextEn": "sample string 4",
    "MessageImageUrl": "sample string 5",
    "MessageType": "sample string 6"
  },
  "ModifiedDate": "2024-10-01T13:37:45.3669782+00:00"
}