POST api/pinches
Create a new Pinch
Request Information
URI Parameters
None.
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": "895f0939-7bd6-435c-823e-d36a92f0540d",
"Name": "sample string 2"
},
"App": {
"Id": "895f0939-7bd6-435c-823e-d36a92f0540d",
"Name": "sample string 2"
},
"ValidFrom": "2026-01-10T00:50:28.4252663+00:00",
"ValidTo": "2026-01-10T00:50:28.4252663+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": "13455f80-38a3-4674-941c-7632423dd70d",
"Name": "sample string 2",
"Description": "sample string 3",
"ExpirationPeriod": "sample string 4",
"UserLimit": 5,
"AppTimeLimitHours": 6,
"ValidFrom": "2026-01-10T00:50:28.4407612+00:00",
"ValidTo": "2026-01-10T00:50:28.4407612+00:00",
"Status": "Draft",
"CustomerGroup": {
"Id": "3908c46e-a5c3-4a11-bbd3-9f15d09a8369",
"Name": "sample string 2"
},
"Customer": {
"Id": "3908c46e-a5c3-4a11-bbd3-9f15d09a8369",
"Name": "sample string 2"
},
"App": {
"NotificationType": "Bubble",
"Id": "0ae30f64-ef1b-40f6-ab23-f4d297d1d5b8",
"Name": "sample string 2"
},
"DailySchedule": {
"From": "sample string 1",
"To": "sample string 2"
},
"IsActive": true,
"Tags": [
"sample string 1",
"sample string 2"
],
"PublishId": "67ba494c-d314-4467-b2ed-b9a08bf93ddb",
"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-01-10T00:50:28.4407612+00:00"
}