# API de Campanhas

## createCampaign

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

Cria uma campanha de push dentro do aplicativo.

#### Corpo da Requisição

| Nome | Tipo | Descrição |
| --- | --- | --- |
| auth\* | string | [Token de acesso à API](/pt/developer/api-reference/api-identifiers/#api-access-token) do Painel de Controle Pushwoosh. |
| application\* | string | [Código da aplicação Pushwoosh](/pt/developer/api-reference/api-identifiers/#application-code) |
| name\* | string | Nome da campanha. |
| description | string | Descrição da campanha. |

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

```
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",       // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "application": "XXXXX-XXXXX",         // obrigatório. Código da aplicação Pushwoosh
    "name": "CAMPAIGN_NAME",              // obrigatório.
    "description": "CAMPAIGN_DESCRIPTION" // opcional.
  }
}
```

## deleteCampaign

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

Exclui uma campanha específica.

#### Corpo da Requisição

| Nome | Tipo | Descrição |
| --- | --- | --- |
| auth\* | string | [Token de acesso à API](/pt/developer/api-reference/api-identifiers/#api-access-token) do Painel de Controle Pushwoosh. |
| campaign\* | string | [Código de uma campanha](/pt/developer/api-reference/api-identifiers/#campaign-code) para excluir. |

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

```json title="Exemplo"
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "campaign": "XXXXX-XXXXX"       // obrigatório. ID de uma campanha para excluir
  }
}
```

## getCampaigns

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

Recupera a lista de campanhas para o aplicativo.

#### Corpo da Requisição

| Nome | Tipo | Descrição |
| --- | --- | --- |
| auth\* | string | [Token de acesso à API](/pt/developer/api-reference/api-identifiers/#api-access-token) do Painel de Controle Pushwoosh. |
| application\* | string | [Código da aplicação Pushwoosh](/pt/developer/api-reference/api-identifiers/#application-code) |
| cursor | string | Indica a última campanha recuperada na requisição anterior. |
| limit | integer | O número máximo de campanhas para uma única resposta. |

<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="Exemplo"
{
  "request": {
    "auth": "jLbec2UW........ztFSOf5Za",   // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
    "application": "XXXXX-XXXXX",          // obrigatório. Código da aplicação Pushwoosh
    "cursor": "+4PxJPhhwITD4PFsiKui1BA==", // opcional. Indica a última campanha recuperada na requisição anterior.
    "limit": 100                           // opcional. O número máximo de campanhas
                                           //           para uma única resposta.
  }
}
```