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": "e9e97310-9f33-4b8c-ad1a-d7340ed546f8",
"Name": "sample string 2"
},
"App": {
"Id": "e9e97310-9f33-4b8c-ad1a-d7340ed546f8",
"Name": "sample string 2"
},
"ValidFrom": "2026-03-12T07:04:43.6606364+00:00",
"ValidTo": "2026-03-12T07:04:43.6606364+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": "d879c167-5fd8-4702-a5ad-b8be669396c1",
"Name": "sample string 2",
"Description": "sample string 3",
"ExpirationPeriod": "sample string 4",
"UserLimit": 5,
"AppTimeLimitHours": 6,
"ValidFrom": "2026-03-12T07:04:43.6762591+00:00",
"ValidTo": "2026-03-12T07:04:43.6762591+00:00",
"Status": "Draft",
"CustomerGroup": {
"Id": "4bff94b9-fc5e-45ad-aca4-067b150f461c",
"Name": "sample string 2"
},
"Customer": {
"Id": "4bff94b9-fc5e-45ad-aca4-067b150f461c",
"Name": "sample string 2"
},
"App": {
"NotificationType": "Bubble",
"Id": "05684865-fd20-436d-9c1a-da52b8b84c45",
"Name": "sample string 2"
},
"DailySchedule": {
"From": "sample string 1",
"To": "sample string 2"
},
"IsActive": true,
"Tags": [
"sample string 1",
"sample string 2"
],
"PublishId": "1cbc15f3-4f36-4176-8799-7e16a9a0ef1f",
"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": "2026-03-12T07:04:43.6762591+00:00"
}