# Campaigns API

## createCampaign

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

يقوم بإنشاء حملة push داخل التطبيق.

#### محتوى الطلب

| الاسم | النوع | الوصف |
| --------------------------------------------- | ------ | ---------------------------------------------- |
| auth\* | string | [API access token](/ar/developer/api-reference/api-identifiers/#api-access-token) من لوحة تحكم Pushwoosh. |
| application\* | string | [Pushwoosh application code](/ar/developer/api-reference/api-identifiers/#application-code) |
| name\* | string | اسم الحملة. |
| description | string | وصف الحملة. |

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

```javascript
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",       // مطلوب. API access token من لوحة تحكم Pushwoosh
    "application": "XXXXX-XXXXX",         // مطلوب. Pushwoosh application code
    "name": "CAMPAIGN_NAME",              // مطلوب.
    "description": "CAMPAIGN_DESCRIPTION" // اختياري.
  }
}
```

## deleteCampaign

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

يقوم بحذف حملة معينة.

#### محتوى الطلب

| الاسم | النوع | الوصف |
| ------------------------------------------ | ------ | ---------------------------------------------- |
| auth\* | string | [API access token](/ar/developer/api-reference/api-identifiers/#api-access-token) من لوحة تحكم Pushwoosh. |
| campaign\* | string | [كود الحملة](/ar/developer/api-reference/api-identifiers/#campaign-code) المراد حذفها. |

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

```javascript title="Example"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // مطلوب. API access token من لوحة تحكم Pushwoosh
    "campaign": "XXXXX-XXXXX"       // مطلوب. معرف الحملة المراد حذفها
  }
}
```

## getCampaigns

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

يسترجع قائمة الحملات الخاصة بالتطبيق.

#### محتوى الطلب

| الاسم | النوع | الوصف |
| --------------------------------------------- | ------- | --------------------------------------------------------------- |
| auth\* | string | [API access token](/ar/developer/api-reference/api-identifiers/#api-access-token) من لوحة تحكم Pushwoosh. |
| application\* | string | [Pushwoosh application code](/ar/developer/api-reference/api-identifiers/#application-code) |
| cursor | string | يشير إلى آخر حملة تم استرجاعها في الطلب السابق. |
| limit | integer | الحد الأقصى لعدد الحملات في استجابة واحدة. |

<Tabs>
<TabItem label="200">
```json
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "campaigns": [{
      "code": "7CFF3-63A7B",
      "name": "CAMPAIGN_NAME_1",
      "description": "DESCRIPTION1"
    }, {
      "code": "C284C-33DD3",
      "name": "CAMPAIGN_NAME_2",
      "description": "DESCRIPTION2"
    }],
    "limit": 100,
    "cursor": "+4PxJPhhwITD4PFsiKui1BA=="
  }
}
```
</TabItem>
</Tabs>

```javascript title="Example"
{
  "request": {
    "auth": "jLbec2UW........ztFSOf5Za",   // مطلوب. API access token من لوحة تحكم Pushwoosh
    "application": "XXXXX-XXXXX",          // مطلوب. Pushwoosh application code
    "cursor": "+4PxJPhhwITD4PFsiKui1BA==", // اختياري. يشير إلى آخر حملة تم استرجاعها في الطلب السابق.
    "limit": 100                           // اختياري. الحد الأقصى لعدد الحملات
                                           //           لاستجابة واحدة.
  }
}
```