CreateCampaignDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input for creating a campaign. The new campaign starts in `Draft`.
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.
Fields
| Field | Type | Description |
|---|---|---|
merchantId
required |
string (uuid) | The merchant that owns this campaign. Required on create, and immutable afterwards: an update
that names a different merchant is refused rather than silently moving the campaign and every
link pointing at it.
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.
|
name
required |
string | Operator-facing campaign name. Never shown to payers.
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.
|
description
required |
string | Free-text description of the campaign.
nullablemax length 1024
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. `null` means it starts as soon as it
is activated.
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. `null` means it stays open until it is
ended explicitly.
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 when someone opens a member link while the campaign is not
accepting payments. `null` falls back to the platform default copy.
nullablemax length 512
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, carried through to reporting.
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.
|
maxCompletions
required |
integer (int32) | The number of approved payments at which the campaign ends on its own, or `null` for
no completion cap. Must be greater than zero when set. Enforced exactly: the payment that
would exceed it is refused at submit, and two payers cannot both take the last slot.
nullablegreater than 0
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. Must be greater than zero when set. A payment already in flight when the cap is
reached still completes, so the total can overshoot by the payments in flight at that
instant.
nullablegreater than 0
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. Must be greater
than zero when set. Drives the progress bar and the `Campaign.Milestone` and
`Campaign.GoalReached` notifications; reaching it never ends the campaign.
nullablegreater than 0
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 the caps and the goal are
measured against. Off by default: the total only ever goes up.
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 count, total and goal are shown to payers on its hosted pages and
links, and published at `GET /api/campaigns/{id}/progress`. Off by default: nothing
about the campaign leaves the merchant's own surfaces.
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. On an update, leave this out (or send `null`) to keep the overrides the campaign
already has; send an object to replace them all, where each member left out or `null`
inherits the 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: This body has no documented fields. | ||
This model has no documented fields.