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 | Description | 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": "a947a824-d7a2-466e-ab2e-79eca671695c",
"Name": "sample string 2"
},
"App": {
"Id": "a947a824-d7a2-466e-ab2e-79eca671695c",
"Name": "sample string 2"
},
"ValidFrom": "2025-11-23T22:44:17.070144+00:00",
"ValidTo": "2025-11-23T22:44:17.070144+00:00",
"Tags": [
"sample string 1",
"sample string 2"
]
}
Response Information
Resource Description
PinchDto| Name | Description | 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": "690dc5a2-afa4-4f9e-bde2-b101b902fe3d",
"Name": "sample string 2",
"Description": "sample string 3",
"ExpirationPeriod": "sample string 4",
"UserLimit": 5,
"AppTimeLimitHours": 6,
"ValidFrom": "2025-11-23T22:44:17.1013951+00:00",
"ValidTo": "2025-11-23T22:44:17.1013951+00:00",
"Status": "Draft",
"CustomerGroup": {
"Id": "537a89bf-b55a-4491-9598-5104a3a8e2ee",
"Name": "sample string 2"
},
"Customer": {
"Id": "537a89bf-b55a-4491-9598-5104a3a8e2ee",
"Name": "sample string 2"
},
"App": {
"NotificationType": "Bubble",
"Id": "da2bb43c-6f24-44b1-9c9e-66dfa8538260",
"Name": "sample string 2"
},
"DailySchedule": {
"From": "sample string 1",
"To": "sample string 2"
},
"IsActive": true,
"Tags": [
"sample string 1",
"sample string 2"
],
"PublishId": "2166e4ac-a564-477d-b7f1-13c2224b752b",
"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": "2025-11-23T22:44:17.1170917+00:00"
}