# Presets API
## createPreset
`POST` `https://api.pushwoosh.com/json/1.3/createPreset`
Erstellt ein neues Preset.
#### Request Body
| Name | Typ | Beschreibung |
| --- | --- | --- |
| auth\* | string | [API-Zugriffstoken](/de/developer/api-reference/api-identifiers/#api-access-token) aus dem Pushwoosh Control Panel. |
| name\* | string | Name des Presets. |
| applicationCode\* | string | [Pushwoosh-Anwendungscode](/de/developer/api-reference/api-identifiers/#application-code) |
| campaignCode | string | [Code einer Kampagne](/de/developer/api-reference/api-identifiers/#campaign-code), der Sie dieses Preset zuweisen möchten. |
| content\* | object | Parameter für den Nachrichteninhalt. |
| content.message\* | string | String oder Array. Nachrichteninhalt. Falls es ein String ist, wird die Sprache "Default" verwendet. |
| content.action | object | Benutzerdefinierte Aktionsparameter. Siehe das Beispiel unten. |
| content.userData | array | Benutzerdefinierte Benutzerdaten. Werden als Parameter "u" in der Payload übergeben (in JSON-String konvertiert). |
| content.properties | array | Spezifischer Inhalt für verschiedene Plattformen. Siehe das Beispiel unten. |
| scheduling.sendRate | integer | Drosselung. Gültige Werte liegen zwischen 100 und 1000 Pushes/Sekunde. |
| segmentation | object | Segmentierungsparameter |
| segmentation.filter | string | [Segment- (Filter-) Name](/de/developer/api-reference/api-identifiers/#segment--filter-name) |
| segmentation.platforms\* | array | Array von Ganzzahlen. Die Liste der Plattform-IDs. 1 - iOS, 3 - Android, 7 - Mac OS X, 8 - Windows, 9 - Amazon, 10 - Safari, 11 - Chrome, 12 - Firefox. |
```json
{
"status_code": 200,
"status_message": "OK"
}
```
```json title="Beispiel"
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel.
"name": "PRESET_NAME", // erforderlich.
"applicationCode": "XXXXX-XXXXX", // erforderlich. Pushwoosh-Anwendungscode.
"applicationGroupCode": "AAAAA-BBBBB", // optional. Kann anstelle von "applicationCode" verwendet werden.
"campaignCode": "CCCCC-DDDDD", // optional. Kampagnencode.
"content": { // erforderlich. Enthält Nachrichtendaten.
"message": { // erforderlich. String oder Objekt. Nachrichteninhalt. Falls es
"en": "English message", // ein String ist, wird die Standardsprache verwendet.
"fr": "French message" // Nachrichteninhalt lokalisiert für verschiedene Sprachen.
}, // Nur ISO 639-1:2002 für Sprachcodes.
"title": { // optional. String oder Objekt. Für Mehrsprachigkeit, Titel
"en": "English title", // für jede Sprache im Objekt festlegen. Ignoriert, wenn
"fr": "French title" // plattformspezifische Titel angegeben sind (z. B.
}, // 'ios_title', 'android_header' usw.; siehe die
// Beispiele für plattformspezifische Parameter in
// der /createMessage API).
"subtitle": { // optional. String oder Objekt. Für Mehrsprachigkeit, Titel
"en": "English subtitle", // für jede Sprache im Objekt festlegen. Ignoriert, wenn
"fr": "French subtitle" // plattformspezifische Untertitel angegeben sind (z. B.
}, // 'ios_subtitle' usw.; siehe die Beispiele für
// plattformspezifische Parameter in der /createMessage API).
"action": { // optional. Aktion, die ausgeführt wird, sobald ein Benutzer eine Nachricht öffnet.
"type": "url", // optional. Art der Aktion. Verfügbare Typen: "url", "deepLink",
// "richMedia", "openApp"(Standard).
"options": { // optional. Optionen für Aktionstypen. Erforderlich für alle
// Aktionstypen außer für "openApp".
"url": "https://example.com", // erforderlich für Aktionstyp "url", String. Wird gekürzt,
// wenn Shortener definiert ist.
"shortener": 2, // optional. Verfügbare Werte: 0 - nicht minimieren, 2 - bit.ly.
// Wenn kein Shortener angegeben ist, wird standardmäßig
// der bit.ly-Shortener verwendet.
"richMediaCode": "BBBBB-AAAAA", // erforderlich für Aktionstyp "richMedia", String.
// Rich-Media-Code aus dem Pushwoosh Control Panel.
"id": 123, // erforderlich für Aktionstyp "deepLink", Integer. Deep-Link-ID.
"params": { // optional, benutzerdefinierte Parameter, erforderlich für Aktionstyp "deepLink", Array.
"param1": "value1",
"param2": "value2"
}
}
},
"userData": { // optional. Benutzerdefinierte Benutzerdaten. Werden als Parameter "u"
"CustomData": "value" // in der Payload übergeben (in JSON-String konvertiert).
},
"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": { // optional. Planungsoptionen.
"sendRate": 1000 // optional. Drosselung. Gültige Werte sind von 100 bis 1000 Pushes/Sekunde.
},
"segmentation": { // erforderlich. Segmentierungsoptionen.
"filter": "FILTER NAME", // optional. Filtername aus Ihrem Pushwoosh Control Panel.
"platforms": [1, 3] // erforderlich. Die Liste der Plattform-IDs: 1 — iOS; 3 — Android;
// 7 — Mac OS X; 8 — Windows; 9 — Amazon; 10 — Safari;
// 11 — Chrome; 12 — Firefox;
}
}
}
```
## getPreset
`POST` `https://api.pushwoosh.com/json/1.3/getPreset`
Ruft die Parameter des spezifischen Push-Presets ab.
#### Request Body
| Name | Typ | Beschreibung |
| --- | --- | --- |
| auth\* | string | [API-Zugriffstoken](/de/developer/api-reference/api-identifiers/#api-access-token) aus dem Pushwoosh Control Panel. |
| preset\_code\* | string | Push-[Preset-Code](/de/developer/api-reference/api-identifiers/#preset-code), für den Informationen abgerufen werden sollen. |
```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]
}
}
}
```
```json title="Beispiel"
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H", // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
"preset_code": "AAAAA-BBBBB" // erforderlich. Push-Preset-Code, für den Informationen abgerufen werden sollen
}
}
```
## listPresets
`POST` `https://api.pushwoosh.com/json/1.3/listPresets`
Ruft die Liste der für die App erstellten Presets ab.
#### Request Body
| Name | Typ | Beschreibung |
| --- | --- | --- |
| auth\* | string | [API-Zugriffstoken](/de/developer/api-reference/api-identifiers/#api-access-token) aus dem Pushwoosh Control Panel. |
| application\* | string | [Pushwoosh-Anwendungscode](/de/developer/api-reference/api-identifiers/#application-code) |
```json
{
"status_code": 200,
"status_message": "OK",
"response": {
"presets": []
}
}
```
```json
{
"status_code": 200,
"status_message": "OK",
"response": {
"presets": [{
"name": "test",
"code": "AAAAA-BBBBB"
}]
}
}
```
```
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
"application": "XXXXX-XXXXX" // erforderlich. Pushwoosh-Anwendungscode
}
}
```
## deletePreset
`POST` `https://api.pushwoosh.com/json/1.3/deletePreset`
Löscht ein Preset aus Ihrem Konto.
#### Request Body
| Name | Typ | Beschreibung |
| --- | --- | --- |
| auth\* | string | [API-Zugriffstoken](/de/developer/api-reference/api-identifiers/#api-access-token) aus dem Pushwoosh Control Panel. |
| preset\_code\* | string | [Preset-Code](/de/developer/api-reference/api-identifiers/#preset-code), abgerufen aus dem Pushwoosh Control Panel oder der `/listPresets`-API-Antwort. |
```json
{
"status_code": 200,
"status_message": "OK",
"response": null
}
```
```json title="Beispiel"
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
"preset_code": "AAAAA-BBBBB" // erforderlich. Code eines zu löschenden Presets
}
}
```