PUT api/pinches/{pinchId}/general

Update a Pinch's General Part

Request Information

URI Parameters

Name	Description	Type	Additional information
pinchId		globally unique identifier	Required

Body Parameters

PinchGeneralDto

Name	Type	Additional information
Name	string	Required Max length: 500
Description	string	Max length: 1000
Status	PinchStatusEnum	None.
CustomerGroup	NamedItem	Required
App	NamedItem	Required
ValidFrom	date	None.
ValidTo	date	None.
Tags	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Status": "Draft",
  "CustomerGroup": {
    "Id": "12b44d49-1589-455a-a004-abc866cd62d2",
    "Name": "sample string 2"
  },
  "App": {
    "Id": "12b44d49-1589-455a-a004-abc866cd62d2",
    "Name": "sample string 2"
  },
  "ValidFrom": "2024-10-01T13:39:20.3256821+00:00",
  "ValidTo": "2024-10-01T13:39:20.3256821+00:00",
  "Tags": [
    "sample string 1",
    "sample string 2"
  ]
}

Response Information

Resource Description

PinchDto

Name	Type	Additional 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": "f33ea96d-fd8f-46ef-b806-90ed48d86f0b",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ExpirationPeriod": "sample string 4",
  "UserLimit": 5,
  "AppTimeLimitHours": 6,
  "ValidFrom": "2024-10-01T13:39:20.3256821+00:00",
  "ValidTo": "2024-10-01T13:39:20.3256821+00:00",
  "Status": "Draft",
  "CustomerGroup": {
    "Id": "f4397f4f-4db9-4724-b733-a7715343f32e",
    "Name": "sample string 2"
  },
  "Customer": {
    "Id": "f4397f4f-4db9-4724-b733-a7715343f32e",
    "Name": "sample string 2"
  },
  "App": {
    "NotificationType": "Bubble",
    "Id": "d6038910-01e7-46fc-9bc1-9a589fd7be2a",
    "Name": "sample string 2"
  },
  "DailySchedule": {
    "From": "sample string 1",
    "To": "sample string 2"
  },
  "IsActive": true,
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "PublishId": "c710243a-06bd-4628-8a9c-473b4d15ce86",
  "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:39:20.3256821+00:00"
}