# Campaigns API

## createCampaign

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

在应用内创建一个推送活动。

#### 请求体

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| auth\* | string | 来自 Pushwoosh 控制面板的 [API Access Token](/zh/developer/api-reference/api-identifiers/#api-access-token)。 |
| application\* | string | [Pushwoosh Application Code](/zh/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>

```
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",       // 必填。来自 Pushwoosh 控制面板的 API Access Token
    "application": "XXXXX-XXXXX",         // 必填。Pushwoosh Application Code
    "name": "CAMPAIGN_NAME",              // 必填。
    "description": "CAMPAIGN_DESCRIPTION" // 可选。
  }
}
```

## deleteCampaign

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

删除特定活动。

#### 请求体

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| auth\* | string | 来自 Pushwoosh 控制面板的 [API Access Token](/zh/developer/api-reference/api-identifiers/#api-access-token)。 |
| campaign\* | string | 要删除的 [活动代码](/zh/developer/api-reference/api-identifiers/#campaign-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 Access Token
    "campaign": "XXXXX-XXXXX"       // 必填。要删除的活动 ID
  }
}
```

## getCampaigns

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

检索应用的活动列表。

#### 请求体

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| auth\* | string | 来自 Pushwoosh 控制面板的 [API Access Token](/zh/developer/api-reference/api-identifiers/#api-access-token)。 |
| application\* | string | [Pushwoosh Application Code](/zh/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>

```json title="Example"
{
  "request": {
    "auth": "jLbec2UW........ztFSOf5Za",   // 必填。来自 Pushwoosh 控制面板的 API Access Token
    "application": "XXXXX-XXXXX",          // 必填。Pushwoosh Application Code
    "cursor": "+4PxJPhhwITD4PFsiKui1BA==", // 可选。指示在上一个请求中检索到的最后一个活动。
    "limit": 100                           // 可选。单个响应的最大活动数量。
  }
}
```