> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequenzy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Stop a Push Campaign

> Stop a scheduled or sending push campaign

# Stop a Push Campaign

Stops a scheduled or sending push campaign. Contacts who have not been sent the push yet are skipped with the reason `campaign_cancelled`; delivered notifications cannot be recalled. `POST /api/v1/campaigns/{campaignId}/cancel` does the same for push campaigns. Requires the `campaigns:send` scope.

## Request

<ParamField path="campaignId" type="string" required>
  The push campaign ID.
</ParamField>

No request body.

```bash theme={null}
curl -X POST "https://api.sequenzy.com/api/v1/push/campaigns/cmp_abc123/cancel" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY"
```

## Responses

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "campaign": {
      "id": "cmp_abc123",
      "name": "Flash sale",
      "type": "push",
      "status": "cancelled",
      "content": {
        "title": "24h sale",
        "body": "30% off everything",
        "url": "https://shop.example.com/sale",
        "imageUrl": null,
        "iconUrl": null,
        "platforms": [
          "web",
          "ios"
        ]
      },
      "targetLists": {
        "type": "all"
      },
      "scheduledAt": null,
      "sentAt": null,
      "estimatedRecipientCount": null,
      "labelIds": [],
      "createdAt": "2026-10-01T12:00:00.000Z",
      "updatedAt": "2026-10-01T12:00:00.000Z"
    }
  }
  ```

  ```json 400 theme={null}
  {
    "error": "This campaign is not a push campaign."
  }
  ```

  ```json 401 theme={null}
  {
    "error": "Invalid API key"
  }
  ```

  ```json 403 theme={null}
  {
    "error": "API key is missing required scope: campaigns:send"
  }
  ```

  ```json 404 theme={null}
  {
    "error": "Campaign not found."
  }
  ```

  ```json 409 theme={null}
  {
    "error": "Only scheduled or sending push campaigns can be stopped."
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.