Returns a paused campaign to active.

POST /api/campaigns/{id}/resume deprecated

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

Requires API key scope: transactions:write (Take payments)

Links that were individually deactivated while the campaign was paused stay deactivated: resuming changes the campaign and nothing else.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

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

PowerShell

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

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

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

TypeScript (raw HTTP)

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

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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.CampaignsResumeAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

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

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

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

pip install winkpg-api

Python (SDK)

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_resume("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

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

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

Parameters

Name In Type Description

id required

path

string (uuid)

The campaign id.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

Body: CampaignDto CampaignDto Each item has these fields.

Field Type Description

extraProperties required

object

nullableread only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDeleted required

boolean

Indicates whether this entity has been deleted.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deleterId required

string (uuid)

The ID of the user who deleted this entity, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deletionTime required

string (date-time)

The date and time when this entity was deleted, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

The merchant that owns this campaign.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Operator-facing campaign name. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Free-text description of the campaign. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

status required

CampaignStatus CampaignStatus

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: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

CampaignEndedReason CampaignEndedReason

Why the campaign ended, or `null` while it has not ended. A campaign that ended only because its window closed reports `Schedule`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isAcceptingPayments required

boolean

Whether member payment links may transact through this campaign right now. False before the scheduled start, and for any status other than active.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

startsAtUtc required

string (date-time)

UTC moment the campaign starts accepting payments. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

endsAtUtc required

string (date-time)

UTC moment the campaign stops accepting payments. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inactiveMessage required

string

Payer-facing message shown while the campaign is not accepting payments. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

externalReference required

string

The merchant's own identifier for this campaign. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

overrides required

CampaignOverridesDto CampaignOverridesDto

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of CampaignOverridesDto:

Field Type Description

panelBackColor required

string

Panel background color, for example `#ffffff`. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

panelBorderColor required

string

Panel border color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

buttonColor required

string

Process button color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

buttonBorderColor required

string

Process button border color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldBorderColor required

string

Input field border color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldBackgroundColor required

string

Input field background color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldFontSize required

integer (int32)

Input field font size, in pixels. nullablemin 1max 72

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldFontColor required

string

Input field font color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

inputFieldBackgroundFocusColor required

string

Input field background color while the field has focus. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

backColor required

string

Page background color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fontColor required

string

Body font color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

font required

string

Body font family. nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fontSize required

integer (int32)

Body font size, in pixels. nullablemin 1max 72

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerFont required

string

Header font family. nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerFontColor required

string

Header font color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerFontSize required

integer (int32)

Header font size, in pixels. nullablemin 1max 72

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerBackColor required

string

Header background color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerBorderColor required

string

Header border color. nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

customCSS required

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. nullablemax length 3000

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

headerText required

string

Text shown at the top of each member page. nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

promoText required

string

Highlighted announcement or promotion text. nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

promoLink required

string

HTTPS link the promotion text points at. nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

processButtonText required

string

Text on the process button. nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

callToActionText required

string

Text on the call-to-action button of a streamlined page. nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

bannerImage required

string

Banner image: the filename the portal image uploader returns, for example `3f2a5b90-7c41-4d2e-9f0a-1b8c6d5e4f21.png`. Not a URL. nullablemax length 128

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

hideBanner required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

clonedFromCampaignId required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maxCompletions required

integer (int32)

The number of approved payments at which the campaign ends on its own, or `null` for no completion cap. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maxTotalAmount required

number (double)

The net collected amount at which the campaign ends on its own, or `null` for no amount cap. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

goalAmount required

number (double)

The amount the campaign is aiming to collect, or `null` for no goal. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

refundsReduceTotal required

boolean

Whether refunds, voids and reversals reduce the collected total.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

showProgress required

boolean

Whether the campaign's progress is shown to payers and published anonymously.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

completedCount required

integer (int32)

Approved payments counted so far. Zero on a campaign that has taken none.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

approvedTotal required

number (double)

The approved base amount collected so far, before any refund.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

refundedTotal required

number (double)

The amount refunded, voided or reversed so far.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

netTotal required

number (double)

The total the caps and the goal are measured against: approved less refunded when refunds reduce the total, approved otherwise.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastCompletedAtUtc required

string (date-time)

When the most recent approved payment was counted (UTC), or `null` before the first. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

percentOfGoal required

integer (int32)

The net total as a whole percentage of the goal, not capped at 100, or `null` without a goal. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

Optimistic concurrency token. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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 lists the values `error.code` can take. 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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Campaigns

The API reference isn't available right now

No such operation

This reference may be out of date

Returns a paused campaign to active.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication