View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.

API reference Models

CampaignOverridesDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Branding and text a campaign lays over every hosted page and payment link that belongs to it. Each member is optional; leave one out, or send `null`, and each member page keeps its own value for it.

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
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 model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.