# Presets API

## createPreset

`POST` `https://api.pushwoosh.com/json/1.3/createPreset`

एक नया प्रीसेट बनाता है।

#### Request Body

| Name | Type | Description |
| --- | --- | --- |
| auth\* | string | Pushwoosh कंट्रोल पैनल से [API एक्सेस टोकन](/hi/developer/api-reference/api-identifiers/#api-access-token)। |
| name\* | string | प्रीसेट का नाम। |
| applicationCode\* | string | [Pushwoosh एप्लिकेशन कोड](/hi/developer/api-reference/api-identifiers/#application-code) |
| campaignCode | string | [कैंपेन का कोड](/hi/developer/api-reference/api-identifiers/#campaign-code) जिसे आप यह प्रीसेट असाइन करना चाहते हैं। |
| content\* | object | संदेश सामग्री पैरामीटर। |
| content.message\* | string | स्ट्रिंग या एरे। संदेश सामग्री। यदि यह एक स्ट्रिंग है, तो "Default" भाषा का उपयोग किया जाएगा। |
| content.action | object | कस्टम एक्शन पैरामीटर। नीचे दिया गया उदाहरण देखें। |
| content.userData | array | कस्टम यूज़र डेटा। पेलोड में "u" पैरामीटर के रूप में पास किया जाएगा (JSON स्ट्रिंग में परिवर्तित)। |
| content.properties | array | विभिन्न प्लेटफ़ॉर्म के लिए विशिष्ट सामग्री। नीचे दिया गया उदाहरण देखें। |
| scheduling.sendRate | integer | थ्रॉटलिंग। मान्य मान 100 से 1000 पुश/सेकंड तक हैं। |
| segmentation | object | सेगमेंटेशन पैरामीटर |
| segmentation.filter | string | [सेगमेंट (फ़िल्टर) का नाम](/hi/developer/api-reference/api-identifiers/#segment--filter-name) |
| segmentation.platforms\* | array | पूर्णांकों (integers) का एरे। प्लेटफ़ॉर्म आईडी की सूची। 1 - iOS, 3 - Android, 7 - Mac OS X, 8 - Windows, 9 - Amazon, 10 - Safari, 11 - Chrome, 12 - Firefox। |

<Tabs>
<TabItem label="200">
```json
{
  "status_code": 200,
  "status_message": "OK"
}
```
</TabItem>
</Tabs>

```json title="Example"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",        // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
    "name": "PRESET_NAME",                 // आवश्यक।
    "applicationCode": "XXXXX-XXXXX",      // आवश्यक। Pushwoosh एप्लिकेशन कोड।
    "applicationGroupCode": "AAAAA-BBBBB", // वैकल्पिक। "applicationCode" के बजाय उपयोग किया जा सकता है।
    "campaignCode": "CCCCC-DDDDD",         // वैकल्पिक। कैंपेन कोड।
    "content": {                           // आवश्यक। संदेश डेटा शामिल है।
      "message": {                         // आवश्यक। स्ट्रिंग या ऑब्जेक्ट। संदेश सामग्री। यदि यह
        "en": "English message",           //           एक स्ट्रिंग है, तो डिफ़ॉल्ट भाषा का उपयोग किया जाएगा।
        "fr": "French message"             //           विभिन्न भाषाओं के लिए स्थानीयकृत संदेश सामग्री।
      },                                   //           भाषा कोड के लिए केवल ISO 639-1:2002।
      "title": {                           // वैकल्पिक। स्ट्रिंग या ऑब्जेक्ट। बहुभाषी के लिए, ऑब्जेक्ट में
        "en": "English title",             //           प्रत्येक भाषा के लिए शीर्षक सेट करें। यदि प्लेटफ़ॉर्म-विशिष्ट
        "fr": "French title"               //           शीर्षक निर्दिष्ट हैं (जैसे, 'ios_title', 'android_header', आदि;
      },                                   //           /createMessage API में प्लेटफ़ॉर्म-विशिष्ट पैरामीटर
                                           //           उदाहरण देखें) तो इसे अनदेखा कर दिया जाता है।
      "subtitle": {                        // वैकल्पिक। स्ट्रिंग या ऑब्जेक्ट। बहुभाषी के लिए, ऑब्जेक्ट में
        "en": "English subtitle",          //           प्रत्येक भाषा के लिए शीर्षक सेट करें। यदि प्लेटफ़ॉर्म-विशिष्ट
        "fr": "French subtitle"            //           उपशीर्षक निर्दिष्ट हैं (जैसे, 'ios_subtitle', आदि;
      },                                   //           /createMessage API में प्लेटफ़ॉर्म-विशिष्ट पैरामीटर
                                           //           उदाहरण देखें) तो इसे अनदेखा कर दिया जाता है।
      "action": {                          // वैकल्पिक। उपयोगकर्ता द्वारा संदेश खोलने पर की जाने वाली कार्रवाई।
        "type": "url",                     // वैकल्पिक। कार्रवाई का प्रकार। उपलब्ध प्रकार: "url", "deepLink",
                                           //            "richMedia", "openApp"(डिफ़ॉल्ट)।
        "options": {                       // वैकल्पिक। कार्रवाई प्रकारों के लिए विकल्प। "openApp" को छोड़कर
                                           //           सभी कार्रवाई प्रकारों के लिए आवश्यक।
          "url": "https://example.com",    // "url" कार्रवाई प्रकार के लिए आवश्यक, स्ट्रिंग। यदि शॉर्टनर
                                           //           परिभाषित है तो छोटा कर दिया जाएगा।
          "shortener": 2,                  // वैकल्पिक। उपलब्ध मान: 0 - छोटा न करें, 2 - bit.ly।
                                           //           यदि कोई शॉर्टनर निर्दिष्ट नहीं है, तो डिफ़ॉल्ट रूप से
                                           //           bit.ly शॉर्टनर का उपयोग किया जाएगा।  
          "richMediaCode": "BBBBB-AAAAA",  // "richMedia" कार्रवाई प्रकार के लिए आवश्यक, स्ट्रिंग।
                                           //           Pushwoosh कंट्रोल पैनल से रिच मीडिया कोड।
          "id": 123,                       // "deepLink" कार्रवाई प्रकार के लिए आवश्यक, पूर्णांक। डीप लिंक आईडी। 
          "params": {                      // वैकल्पिक, कस्टम पैरामीटर, "deepLink" कार्रवाई प्रकार के लिए आवश्यक, एरे।
            "param1": "value1",
            "param2": "value2"
          }
        }
      },
      "userData": {                        // वैकल्पिक। कस्टम यूज़र डेटा। पेलोड में "u" पैरामीटर
        "CustomData": "value"              //           के रूप में पास किया जाएगा (JSON स्ट्रिंग में परिवर्तित)।
      },
      "platforms": {
        "ios": {
          "sound": "default",
          "silent": 1,
          "ttl": 604800,
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          },
          "interruptionLevel": "active"
        },
        "android": {
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          }
        }
      }
    },
    "scheduling": {            // वैकल्पिक। शेड्यूलिंग विकल्प।
      "sendRate": 1000         // वैकल्पिक। थ्रॉटलिंग। मान्य मान 100 से 1000 पुश/सेकंड तक हैं।
    },
    "segmentation": {          // आवश्यक। सेगमेंटेशन विकल्प।
      "filter": "FILTER NAME", // वैकल्पिक। आपके Pushwoosh कंट्रोल पैनल से फ़िल्टर का नाम।
      "platforms": [1, 3]      // आवश्यक। प्लेटफ़ॉर्म आईडी की सूची: 1 — iOS; 3 — Android;
                               //           7 — Mac OS X; 8 — Windows; 9 — Amazon; 10 — Safari;
                               //           11 — Chrome; 12 — Firefox;
    }
  }
}
```

<Aside type="note">
प्लेटफ़ॉर्म-विशिष्ट पैरामीटर के लिए, कृपया [`/createMessage`](/hi/developer/api-reference/messages-api/#createmessage) देखें।
</Aside>

## getPreset

`POST` `https://api.pushwoosh.com/json/1.3/getPreset`

विशिष्ट पुश प्रीसेट के पैरामीटर पुनर्प्राप्त करता है।

#### Request Body

| Name | Type | Description |
| --- | --- | --- |
| auth\* | string | Pushwoosh कंट्रोल पैनल से [API एक्सेस टोकन](/hi/developer/api-reference/api-identifiers/#api-access-token)। |
| preset\_code\* | string | जानकारी प्राप्त करने के लिए पुश [प्रीसेट कोड](/hi/developer/api-reference/api-identifiers/#preset-code)। |

<Tabs>
<TabItem label="200">
```json
{ 
  "status_code": 200,
  "status_message": "OK",
  "response": { 
    "preset": { 
      "code": "XXXXX-XXXXX",
      "name": "Full preset",
      "page_id": 26,
      "url": null,
      "content": { 
        "en": "Some message",
        "de": "Eine Nachricht"
      },
      "properties": { 
        "ignore_user_timezone": 1,
        "ios_badges": "5",
        "ios_sound": "default",
        "ios_ttl": "43200",
        "android_sound": "Sound1.wav",
        "android_custom_icon": "icon.png",
        "android_header": "android_header",
        "android_gcm_ttl": "43200",
        "wns_type": "toast",
        "wns_content": { 
          "template": "ToastImageAndText02",
          "lang-en": { 
            "headlinetext": "Title",
            "bodytext": "super text"
          },
          "languages": ["en", "zh", "it", "sv", "de", "fr", "pt", "nl", "es"],
          "lang-zh": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-it": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-sv": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-de": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-fr": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-pt": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-nl": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-es": { 
            "headlinetext": "",
            "bodytext": ""
          },
          "imagesource": "https:\/\/image.com\/jpg"
        },
        "adm_sound": "song",
        "adm_custom_icon": "i5.bmp",
        "adm_header": "Amazon Header",
        "adm_ttl": "7200",
        "safari_title": "Safari title",
        "safari_action": "OK",
        "safari_url_args": ["hello.com", ""],
        "safari_ttl": "43200",
        "userdata": "{\"custom\":\"data\"}",
        "created_via": "CP",
        "user_id": 2,
        "filter_id": "1"
      },
      "platforms": [1, 3, 7, 10, 11]
    }
  }
}
```
</TabItem>
</Tabs>

```json title="Example"
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "preset_code": "AAAAA-BBBBB"    // आवश्यक। जानकारी प्राप्त करने के लिए पुश प्रीसेट कोड
  }
}
```

## listPresets

`POST` `https://api.pushwoosh.com/json/1.3/listPresets`

ऐप के लिए बनाए गए प्रीसेट की सूची पुनर्प्राप्त करता है।

#### Request Body

| Name | Type | Description |
| --- | --- | --- |
| auth\* | string | Pushwoosh कंट्रोल पैनल से [API एक्सेस टोकन](/hi/developer/api-reference/api-identifiers/#api-access-token)। |
| application\* | string | [Pushwoosh एप्लिकेशन कोड](/hi/developer/api-reference/api-identifiers/#application-code) |

<Tabs>
<TabItem label="No presets">
```json
{
  "status_code": 200, 
  "status_message": "OK", 
  "response": {
    "presets": []
  }
}
```
</TabItem>

<TabItem label="Presets list">
```json
{
  "status_code": 200, 
  "status_message": "OK", 
  "response": {
    "presets": [{
      "name": "test",
      "code": "AAAAA-BBBBB"
    }]
  }
}
```
</TabItem>
</Tabs>

```
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "application": "XXXXX-XXXXX"     // आवश्यक। Pushwoosh एप्लिकेशन कोड
  }
}
```

## deletePreset

`POST` `https://api.pushwoosh.com/json/1.3/deletePreset`

आपके खाते से एक प्रीसेट हटाता है।

#### Request Body

| Name | Type | Description |
| --- | --- | --- |
| auth\* | string | Pushwoosh कंट्रोल पैनल से [API एक्सेस टोकन](/hi/developer/api-reference/api-identifiers/#api-access-token)। |
| preset\_code\* | string | Pushwoosh कंट्रोल पैनल या `/listPresets` API प्रतिक्रिया से प्राप्त [प्रीसेट कोड](/hi/developer/api-reference/api-identifiers/#preset-code)। |

<Tabs>
<TabItem label="200">
```json
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
```
</TabItem>
</Tabs>

```json title="Example"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // आवश्यक। Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन
    "preset_code": "AAAAA-BBBBB"    // आवश्यक। हटाने के लिए प्रीसेट का कोड
  } 
}
```