# POST /api/campaigns/{id}/end

Ends a running or paused campaign.

Terminal, though the campaign stays editable and reportable afterwards.

**Operation ID:** `campaignsEnd`

## Authorization

Requires: Campaigns.Campaigns, Campaigns.Campaigns.ManageStatus, merchant scope.

Requires API key scope: `transactions:write`

Required permissions:
- `Campaigns.Campaigns`
- `Campaigns.Campaigns.ManageStatus`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) | The campaign id. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`CampaignDto`](https://devportal.demo.winkpg.io/docs/api/models/CampaignDto.md)

Properties:
- `extraProperties` (object): (nullable, read only)
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
- `merchantId` (string(uuid)): The merchant that owns this campaign.
- `name` (string): Operator-facing campaign name. (nullable)
- `description` (string): Free-text description of the campaign. (nullable)
- `status` ([CampaignStatus](https://devportal.demo.winkpg.io/docs/api/models/CampaignStatus.md)): The campaign's status right now. A running campaign whose scheduled end has already passed  reads as `Ended` here, without anything having been written to it.
  Values:
  - `Draft`: Being prepared, and not yet running.
  - `Active`: Running. The campaign admits member links, subject to its schedule and to their own status.
  - `Paused`: Suspended by the merchant, and resumable back to Active.
  - `Ended`: Finished. Terminal, though the campaign stays editable and reportable.
  - `Archived`: Retired from the working set. No page or payment link may join it.
- `endedReason` ([CampaignEndedReason](https://devportal.demo.winkpg.io/docs/api/models/CampaignEndedReason.md)): Why the campaign ended, or `null` while it has not ended. A campaign that ended only  because its window closed reports `Schedule`. (nullable)
  Values:
  - `Manual`: A merchant user ended it explicitly.
  - `Schedule`: Its scheduled window closed.
  - `CompletionCap`: Its configured completion count was reached.
  - `AmountCap`: Its configured collected-amount ceiling was reached.
- `endedAtUtc` (string(date-time)): UTC moment the campaign was ended or archived out of a running state, or `null` while it  has not been. A campaign that reads as ended only because its window closed carries none: its  `endsAtUtc` is its end. (nullable)
- `isAcceptingPayments` (boolean): Whether member payment links may transact through this campaign right now. False before the  scheduled start, and for any status other than active.
- `startsAtUtc` (string(date-time)): UTC moment the campaign starts accepting payments. (nullable)
- `endsAtUtc` (string(date-time)): UTC moment the campaign stops accepting payments. (nullable)
- `inactiveMessage` (string): Payer-facing message shown while the campaign is not accepting payments. (nullable)
- `externalReference` (string): The merchant's own identifier for this campaign. (nullable)
- `overrides` ([CampaignOverridesDto](https://devportal.demo.winkpg.io/docs/api/models/CampaignOverridesDto.md)): Branding and text laid over every hosted page and payment link in the campaign when it  renders. A member that is `null` inherits each member page's own value.
  Fields:
  - `panelBackColor` (string): Panel background color, for example `#ffffff`. (nullable, max length 20)
  - `panelBorderColor` (string): Panel border color. (nullable, max length 20)
  - `buttonColor` (string): Process button color. (nullable, max length 20)
  - `buttonBorderColor` (string): Process button border color. (nullable, max length 20)
  - `inputFieldBorderColor` (string): Input field border color. (nullable, max length 20)
  - `inputFieldBackgroundColor` (string): Input field background color. (nullable, max length 20)
  - `inputFieldFontSize` (integer(int32)): Input field font size, in pixels. (nullable, min 1, max 72)
  - `inputFieldFontColor` (string): Input field font color. (nullable, max length 20)
  - `inputFieldBackgroundFocusColor` (string): Input field background color while the field has focus. (nullable, max length 20)
  - `backColor` (string): Page background color. (nullable, max length 20)
  - `fontColor` (string): Body font color. (nullable, max length 20)
  - `font` (string): Body font family. (nullable, max length 50)
  - `fontSize` (integer(int32)): Body font size, in pixels. (nullable, min 1, max 72)
  - `headerFont` (string): Header font family. (nullable, max length 50)
  - `headerFontColor` (string): Header font color. (nullable, max length 20)
  - `headerFontSize` (integer(int32)): Header font size, in pixels. (nullable, min 1, max 72)
  - `headerBackColor` (string): Header background color. (nullable, max length 20)
  - `headerBorderColor` (string): Header border color. (nullable, max length 20)
  - `customCSS` (string): Custom CSS added after each member page's own custom CSS, so a campaign rule wins over a page  rule of equal specificity and the page's other rules keep applying. (nullable, max length 3000)
  - `headerText` (string): Text shown at the top of each member page. (nullable, max length 100)
  - `promoText` (string): Highlighted announcement or promotion text. (nullable, max length 200)
  - `promoLink` (string): HTTPS link the promotion text points at. (nullable, max length 200)
  - `processButtonText` (string): Text on the process button. (nullable, max length 50)
  - `callToActionText` (string): Text on the call-to-action button of a streamlined page. (nullable, max length 50)
  - `bannerImage` (string): Banner image: the filename the portal image uploader returns, for example  `3f2a5b90-7c41-4d2e-9f0a-1b8c6d5e4f21.png`. Not a URL. (nullable, max length 128)
  - `hideBanner` (boolean): Whether the banner is hidden. `true` hides it on every member page, `false` shows it  even on a page that hides its own, and `null` leaves each page's own setting. (nullable)
- `clonedFromCampaignId` (string(uuid)): The campaign this one was cloned from, or `null` for a campaign created from scratch.  The source may have been deleted since; the reference is kept either way. (nullable)
- `maxCompletions` (integer(int32)): The number of approved payments at which the campaign ends on its own, or `null` for no completion cap. (nullable)
- `maxTotalAmount` (number(double)): The net collected amount at which the campaign ends on its own, or `null` for no amount cap. (nullable)
- `goalAmount` (number(double)): The amount the campaign is aiming to collect, or `null` for no goal. (nullable)
- `refundsReduceTotal` (boolean): Whether refunds, voids and reversals reduce the collected total.
- `showProgress` (boolean): Whether the campaign's progress is shown to payers and published anonymously.
- `completedCount` (integer(int32)): Approved payments counted so far. Zero on a campaign that has taken none.
- `approvedTotal` (number(double)): The approved base amount collected so far, before any refund.
- `refundedTotal` (number(double)): The amount refunded, voided or reversed so far.
- `netTotal` (number(double)): The total the caps and the goal are measured against: approved less refunded when refunds  reduce the total, approved otherwise.
- `lastCompletedAtUtc` (string(date-time)): When the most recent approved payment was counted (UTC), or `null` before the first. (nullable)
- `percentOfGoal` (integer(int32)): The net total as a whole percentage of the goal, not capped at 100, or `null` without a goal. (nullable)
- `concurrencyStamp` (string): Optimistic concurrency token. (nullable)

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/campaigns/{id}/end" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/campaigns/{id}/end' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, CampaignsApi } from '@winkpg/winkpg-api';

const api = new CampaignsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.campaignsEnd("3fa85f64-5717-4562-b3fc-2c963f66afa6");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/campaigns/{id}/end', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new CampaignsApi(config);
var result = await api.CampaignsEndAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));
```

### C# (raw HTTP)

```csharp
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/campaigns/{id}/end");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.CampaignsApi(client)
    result = api.campaigns_end("3fa85f64-5717-4562-b3fc-2c963f66afa6")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/campaigns/{id}/end",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.