Input objects

ActivityCreateInput

A task to create on a supporter or a donation.

Arguments

Name	Description
subject ActivitySubject!	Kind of record the task is attached to.
subjectId Int!	Identifier of the record the task is attached to.
category ActivityCategory!	Kind of task to carry out.
deadlineDate Date	Day the task is due.
doneDate Date	Day the task was carried out, to record a task already done.
note String	Free-text note describing the task.
staffId Int	Staff member the task is assigned to. Defaults to the caller when omitted.

ActivityFilters

Search filters for activities. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the note of the activity.
order String	Field to sort by, prefixed with - for descending order.
dueDate DateRange	Keep only tasks due in this range.
userId Int	Keep only the tasks assigned to this staff member.
supporterId Int	Keep only the tasks attached to this supporter.
donationId Int	Keep only the tasks attached to this donation.

ActivityUpdateInput

Fields of a task that can be changed. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
category ActivityCategory	Kind of task to carry out.
deadlineDate Date	Day the task is due.
doneDate Date	Day the task was carried out.
note String	Free-text note describing the task or its outcome.
staffId Int	Staff member the task is assigned to.

ArticleInput

Fields of a blog post that can be written. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
title String	Title of the post.
content String	Body of the post, as HTML.
visibility WebDocumentVisibility	Whether the post is public, reachable only by direct link, or hidden.
slug String	URL segment of the post. Generated from the title when omitted.
seoTitle String	Title used by search engines.
seoDescription String	Meta description used by search engines and link previews.
template String	Name of the theme template rendering the post.
coverId Int	Media used as cover image of the post.
blogId Int	Blog the post belongs to.

ArticlesFiltersInput

Search filters for blog posts.

Arguments

Name	Description
q String	Free-text search over the title and the content of the post.

BlogInput

Fields of a blog that can be written. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
title String	Title of the blog.
content String	Introduction shown on the blog page, as HTML.
visibility WebDocumentVisibility	Whether the blog is public, reachable only by direct link, or hidden.
slug String	URL segment of the blog. Generated from the title when omitted.
seoTitle String	Title used by search engines.
seoDescription String	Meta description used by search engines and link previews.
template String	Name of the theme template rendering the blog.
coverId Int	Media used as cover image of the blog.

BlogsFiltersInput

Search filters for blogs.

Arguments

Name	Description
q String	Free-text search over the title and the content of the blog.

CampaignCommentCreateInput

A comment to attach to a donation. The campaign and the author are taken from the donation.

Arguments

Name	Description
donationId Int!	Donation the comment belongs to.
message String!	Text of the comment.
status CampaignCommentStatus!	Moderation state to create the comment with. Approved by default.
public Boolean!	Whether the comment may be shown publicly.
anonymous Boolean!	Whether the comment must be shown without the name of the donor.

CampaignCommentsFilters

Search filters for the comments left on campaigns. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the text of the comment.
supporterId Int	Keep only the comments of this supporter.
campaignId Int	Keep only the comments left on this campaign.
donationId Int	Keep only the comment attached to this donation.
status CampaignCommentStatus	Keep only comments in this moderation state.

CampaignCommentUpdateInput

Fields of a comment that can be changed while moderating it. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
message String	Text of the comment.
status CampaignCommentStatus	New moderation state of the comment.
public Boolean	Whether the comment may be shown publicly.
anonymous Boolean	Whether the comment must be shown without the name of the donor.

CampaignFilters

Search filters for campaigns. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the title and the content of the campaign.
order String	Field to sort by, prefixed with - for descending order.
tags [String!]	Keep only campaigns carrying at least one of these labels.
tagsNot [String!]	Drop the campaigns carrying all of these labels.
channels [String!]	Keep only campaigns offered on these applications (channels).
ids [Int!]	Restrict the results to these campaigns.
visibility WebDocumentVisibility	Keep only campaigns with this visibility on the public site.

CampaignInput

Fields of a campaign that can be written, including its public page and the configuration of its donation form. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
title String	Title of the campaign page.
content String	Body of the campaign page, as HTML.
visibility WebDocumentVisibility	Whether the page is public, reachable only by direct link, or hidden.
slug String	URL segment of the page. Generated from the title when omitted.
seoTitle String	Title used by search engines.
seoDescription String	Meta description used by search engines and link previews.
template String	Name of the theme template rendering the campaign page.
thankyouTemplate String	Name of the theme template rendering the thank-you page.
receiptNotificationId Int	Notification used to send the receipt for donations to this campaign.
coverId Int	Media used as cover image of the campaign page.
isGoalEnabled Boolean	Whether the goal and its progress bar are shown on the public page.
code String	Human-readable identifier of the campaign, used in reporting.
goal Float	Amount the campaign aims to raise.
type CampaignType	Kind of campaign, which decides how it is presented and collected.
tags [String!]	Full replacement of the labels attached to the campaign.
excludedChannels [Int!]	Identifiers of the applications (channels) the campaign must not be offered on.
excludedPaymentMethods [Int!]	Identifiers of the payment methods that must not be offered on this campaign.
allowPeerToPeer Boolean	Whether supporters may open their own peer-to-peer page for this campaign.
costExamples [CostExampleInput!]	Full replacement of the cost examples offered by the campaign.
hasOneOff Boolean	Whether the form offers one-off donations.
hasSubscription Boolean	Whether the form offers recurring donations.
hasSubscriptionCustomOptions Boolean	Whether recurring donations use their own amounts and limits instead of reusing the one-off ones.
defaultAmount Float	One-off amount preselected on the form.
minAmount Float	Smallest one-off amount accepted.
maxAmount Float	Largest one-off amount accepted.
asks [Float!]	Suggested one-off amounts, shown as buttons on the form.
allowCustomAmount Boolean	Whether the donor may type a one-off amount of their choice.
defaultSubscriptionAmount Float	Recurring amount preselected on the form.
minSubscriptionAmount Float	Smallest recurring amount accepted.
maxSubscriptionAmount Float	Largest recurring amount accepted.
asksSubscription [Float!]	Suggested recurring amounts, shown as buttons on the form.
allowCustomSubscriptionAmount Boolean	Whether the donor may type a recurring amount of their choice.
shownFields [String!]	Names of the supporter fields displayed on the donation form.
requiredFields [String!]	Names of the supporter fields the donor must fill in.
privacyFields [String!]	Codes of the privacy definitions whose consent is asked on the donation form.
privacyNote String	Text shown next to the consent checkboxes on the donation form.
customfields [CustomFieldInput!]	Values of the custom fields defined by the organization for campaigns.

CheckoutCompleteInput

Data needed to turn a checkout session into a donation.

Arguments

Name	Description
paymentMethodId Int	Method the donation will be collected with. Defaults to the one already chosen on the session.

CheckoutFilters

Search filters for checkout sessions. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the data the donor entered on the form.
state CheckoutState	Keep only sessions in this state.
order String	Field to sort by, prefixed with - for descending order.
tags [String!]	Keep only sessions carrying at least one of these labels.
tagsNot [String!]	Drop the sessions carrying all of these labels.
createDate DateRange	Keep only sessions opened in this range.
updateDate DateRange	Keep only sessions last modified in this range.
completedDate DateRange	Keep only sessions completed in this range.

CheckoutInput

Data of a checkout session. Every field is optional and left untouched when omitted, so a session can be filled in step by step as the donor advances through the form.

Arguments

Name	Description
campaignId Int	Campaign the session collects for.
supporterId Int	Existing supporter the session belongs to, when they are already known.
costExampleQuantity Int	How many units of the chosen cost example the donation covers.
peerCampaignId Int	Peer-to-peer page the session was opened from.
amount Float	Amount chosen by the donor.
frequency Frequency	Frequency chosen by the donor.
isPromise Boolean	Whether the session records a promise, i.e. a donation pledged now and paid later, instead of a payment being collected right away.
tags [String!]	Labels to attach to the donation once the session is completed.
paymentMethodId Int	Payment method the donor chose.
supporterData SupporterInput	Personal data and consents entered on the form.
donationData DonationInput	Fields of the donation that will be created, such as its note or its custom fields.
device String	Device or channel the session was opened from.
applicationId Int	Application (channel) the session is opened on behalf of.
applicationMetadata JSON	Free-form JSON the application attaches to the session and that is carried through to the donation.

CheckoutPaymentInput

Data of the payment attempt made on a checkout session.

Arguments

Name	Description
state PaymentState	State to record the payment with, for example settled or failed.
amount Float	Amount collected. Defaults to the amount of the session when omitted.
paymentDate DateTime	When the money was collected. Defaults to now when omitted.
donationId Int	Donation the payment belongs to. Defaults to the one of the session.
paymentMethodId Int	Method the money was collected with.
peerCampaignId Int	Peer-to-peer page the payment must be attributed to.
creditCardId Int	Saved card the payment was charged on.
sepaBankAccountId Int	Saved bank account the payment was debited from.
stripePaymentIntentId String	Identifier of the Stripe payment intent that collected the money.
satispayPaymentIntentId String	Identifier of the Satispay payment that collected the money.

CostExampleInput

A cost example to create or update on a campaign. The list sent on CampaignInput.costExamples replaces the existing one, and examples are matched by uuid.

Arguments

Name	Description
uuid String!	Stable identifier of the example. Send the existing one to update an example, a new one to add it.
name String!	Short label of the example, shown on the donation form.
description String!	Longer explanation of what the amount pays for.
amount Float!	Amount that buys one unit of the example.
imageId Int	Identifier of the media shown next to the example.
monitorQuantity Boolean!	Whether the available quantity must be tracked and the example withdrawn once exhausted.
quantity Int!	Total number of units offered.
availableQuantity Int!	Units still available.

CustomFieldDefinitionCreateInput

A custom field to add to one kind of record.

Arguments

Name	Description
entity CustomFieldEntity!	Kind of record the field is defined on. Cannot be changed afterwards.
name String!	Label shown to operators and donors.
description String	Hint shown under the field.
type CustomFieldType!	Type of value the field holds. Cannot be changed afterwards.
position Int	Order the field is shown in. Appended last when omitted.
options [String!]	Values to choose from. Required by the choice types.

CustomFieldDefinitionUpdateInput

Fields of a custom field definition that can be changed. The entity and the type are fixed once created.

Arguments

Name	Description
name String	Label shown to operators and donors.
description String	Hint shown under the field.
position Int	Order the field is shown in.
options [String!]	Values to choose from.
archived Boolean	Whether the field is archived and no longer offered.

CustomFieldEntityFilter

Restricts a search to the custom fields defined on one kind of record.

Arguments

Name	Description
key String!	Key of the custom field the condition applies to.
value String	Value the field must hold.
defined Boolean	Whether the field must be filled in, or must be empty.

CustomFieldFilters

Search filters for custom field definitions. Filters are combined with a logical AND.

Arguments

Name	Description
entity CustomFieldEntity	Keep only the fields defined on this kind of record.
archived Boolean	Whether to return archived definitions, active ones, or both when omitted.

CustomFieldInput

The value to write on a custom field of a record.

Arguments

Name	Description
key String!	Key of the definition the value belongs to.
value String	Value to write, serialised as a string. Null to clear it.

DateRange

Inclusive range of dates used to filter date fields.

Arguments

Name	Description
start Date	First day accepted, inclusive. Null for no lower bound.
end Date	Last day accepted, inclusive. Null for no upper bound.

DateTimeRange

Inclusive range of instants used to filter timestamp fields.

Arguments

Name	Description
start DateTime	Earliest instant accepted, inclusive. Null for no lower bound.
end DateTime	Latest instant accepted, inclusive. Null for no upper bound.

DonationDomain

Selection of the donations an operation applies to, expressed as search filters or as a list of identifiers.

Arguments

Name	Description
filters DonationFiltersInput	Apply the operation to every donation matching these filters.
ids [Int!]	Apply the operation to these donations only. Takes precedence over filters when both are sent.

DonationFiltersInput

Search filters for donations. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the code of the donation and the data of its supporter.
archived Boolean	Whether to include donations of archived supporters.
order String	Field to sort by, prefixed with - for descending order.
tags [String!]	Keep only donations carrying at least one of these labels.
tagsNot [String!]	Drop the donations carrying all of these labels.
createDate DateRange	Keep only donations created in this range of days.
createDatetime DateTimeRange	Keep only donations created in this range of instants.
updateDate DateRange	Keep only donations last modified in this range of days.
updateDatetime DateRange	Keep only donations last modified in this range of instants.
completedDate DateRange	Keep only donations completed in this range of days.
completedDatetime DateTimeRange	Keep only donations completed in this range of instants.
totalPaid IntRange	Keep only donations whose collected total falls in this range.
totalPayments IntRange	Keep only donations whose number of payments falls in this range.
supporterType SupporterType	Keep only donations from supporters of this nature.
campaigns [Int!]	Keep only donations given to these campaigns.
peerCampaigns [Int!]	Keep only donations collected through these peer-to-peer pages.
supporters [Int!]	Keep only donations from these supporters.
paymentMethods [Int!]	Keep only donations collected with these payment methods.
channels [Int!]	Keep only donations collected through these applications (channels).
frequencies [Frequency!]	Keep only donations with these frequencies.
customfields [CustomFieldEntityFilter!]	Keep only donations whose custom fields match these conditions.
importRuns [Int!]	Keep only donations created by these import runs.

DonationInput

Fields of a donation that can be changed. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
amount Float	New amount of a single instalment, in the currency of the organization.
frequency Frequency	New collection frequency of the pledge.
note String	Internal note attached to the donation.
tags [String!]	Full replacement of the labels attached to the donation.
device String	Device or channel the donation originated from.
isPublic Boolean	Whether the donation may be shown publicly, for example in a donor wall.
customfields [CustomFieldInput!]	Values of the custom fields defined by the organization for donations.

DonationPaymentInput

Data of a payment collected outside Riseact and registered manually against a donation, such as a bank transfer or a cash gift.

Arguments

Name	Description
amount Float	Amount collected. Defaults to the amount of the donation when omitted.
frequency Frequency	Frequency the payment refers to. Defaults to the frequency of the donation when omitted.
paymentDate DateTime	When the money was actually collected. Defaults to now when omitted.
paymentMethodId Int	Payment method the money was collected with.

IntRange

Inclusive range of integer values used to filter numeric fields.

Arguments

Name	Description
start Int	Smallest value accepted, inclusive. Null for no lower bound.
end Int	Largest value accepted, inclusive. Null for no upper bound.

LeadSupporterInput

Same fields as SupporterInput, used when registering a lead: a contact acquired before they gave anything.

Arguments

Name	Description
businessName String	Legal name of the company, family or group.
firstName String	Given name.
lastName String	Family name.
title String	Courtesy title, such as Dr. or Prof.
externalRef String	Identifier of the supporter in the external system they come from. Must be unique inside the organization.
supporterType SupporterType	Nature of the supporter, which decides whether the personal or the business fields apply.
email String	Main email address, used for receipts and notifications.
phone String	Landline number.
mobile String	Mobile number, used for SMS notifications.
job String	Job or role declared by the supporter.
sex Sex	Gender recorded on the supporter.
dateOfBirth Date	Date of birth, required by some tax receipt regimes.
placeOfBirth String	Place of birth, required by some tax receipt regimes.
ssn String	National tax identifier of the person (in Italy, the codice fiscale).
vat String	VAT number of the company.
address String	Street address.
address2 String	Second address line, for care-of details or the like.
city String	City of the address.
locality String	Locality or province of the address.
country String	Country of the address.
postalCode String	Postal code of the address.
emailMarketing Boolean	Consent to receive marketing messages by email.
phoneMarketing Boolean	Consent to be contacted for marketing by phone.
smsMarketing Boolean	Consent to receive marketing messages by SMS.
postalMarketing Boolean	Consent to receive marketing material by post.
profilationMarketing Boolean	Consent to have their data profiled for marketing purposes.
note String	Internal note attached to the supporter.
certificationUrl String	URL of the signed acquisition document collected for the supporter.
image String	URL of the profile picture to attach to the supporter.
tags [String!]	Full replacement of the labels attached to the supporter.
customfields [CustomFieldInput!]	Values of the custom fields defined by the organization for supporters.
privacyValues [SupporterPrivacyInput!]	Consents to record on the supporter, one entry per privacy definition.
sourceCampaignId Int	Campaign the supporter was acquired through.
sourcePeerCampaignId Int	Peer-to-peer page the supporter was acquired through.

ManualPaymentInput

Fields of a payment that can be corrected by hand, such as the date it was actually collected.

Arguments

Name	Description
amount Float!	Corrected amount of the payment.
paymentDate DateTime!	Corrected date the money was collected on.
paymentMethodId Int	Corrected method the money was collected with.

ManualPaymentMethodInput

Configuration of a payment method collected outside Riseact, such as a bank transfer, a cash gift or a direct debit handled by the bank.

Arguments

Name	Description
label String!	Name shown to the donor on the payment step.
hasOneoffSupport Boolean	Whether the method can collect one-off donations.
hasSubscriptionSupport Boolean	Whether the method can collect recurring donations.
description String	Short explanation shown to the donor under the label.
instructions String	Instructions the donor must follow to pay, such as the bank details for a transfer.
channels [Int!]	Identifiers of the applications (channels) the method is offered on. Empty means every channel.
includeInCertificate Boolean	Whether payments collected with this method are counted in the yearly tax certificate of the supporter.
sendInstructions Boolean	Whether the instructions are emailed to the donor after the donation.

MenuInput

Name, handle and entries of a navigation menu. The entries sent replace the existing ones.

Arguments

Name	Description
name String!	Name of the menu, shown in the back-office.
handle String!	Stable handle the theme calls the menu by.
items [MenuItemInput!]!	Entries of the menu, in the order they must be shown. Replaces the existing ones.

MenuItemInput

One entry of a navigation menu.

Arguments

Name	Description
label String!	Text shown in the menu.
link String	Address the entry points at. Null for entries pointing at a page of the site chosen elsewhere.

OrganizationInput

Fields of the organization that can be written. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
name String!	Name of the organization, shown to donors.
logo Int	Media used as logo of the organization.
legalName String	Registered name, used on receipts and invoices.
currency Currencies!	Currency donations are collected in.
isInvoiceRequired Boolean	Whether the organization needs an invoice for what it is billed.
vat String	VAT number of the organization.
vatExchange String	Code or address the electronic invoices must be delivered to.
taxIdentificationNumber String	Tax identifier printed on the receipts issued to donors.
senderEmail String	Address the notifications are sent from. The DNS checks must pass before it is used.
contactEmail String	Email address donors are invited to write to.
contactPhone String	Phone number donors are invited to call.
addressLine1 String	Street address of the registered office.
addressLine2 String	Second address line of the registered office.
city String	City of the registered office.
state String	State or province of the registered office.
country String	Country of the registered office.
postalCode String	Postal code of the registered office.
annualCertificateAutoSend Boolean	Whether the yearly tax certificates are sent to supporters automatically.
annualCertificateSendMonth Int	Month of the year the certificates are sent in, as a number from 1 to 12.
annualCertificateSendDay Int	Day of the month the certificates are sent on.

OrganizationLegalInput

Legal texts and consents shown by the organization on its public site and donation forms.

Arguments

Name	Description
tos String!	Terms of service, as HTML.
privacyPolicy String!	Privacy policy, as HTML.
consentScopes [String!]!	Codes of the consents asked to donors by default.

OrganizationsFilters

Search filters for the organizations the caller has access to.

Arguments

Name	Description
name String	Keep only organizations whose name matches.

PageInput

Fields of a static page that can be written. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
title String	Title of the page.
content String	Body of the page, as HTML.
visibility WebDocumentVisibility	Whether the page is public, reachable only by direct link, or hidden.
slug String	URL segment of the page. Generated from the title when omitted.
seoTitle String	Title used by search engines.
seoDescription String	Meta description used by search engines and link previews.
template String	Name of the theme template rendering the page.
coverId Int	Media used as cover image of the page.

PagesFiltersInput

Search filters for static pages.

Arguments

Name	Description
q String	Free-text search over the title and the content of the page.

PaginationInput

Cursor pagination arguments. Use first/after to walk forward and last/before to walk backwards; first and last cannot be combined. Defaults to the first 25 items.

Arguments

Name	Description
first Int	Number of items to take from the start of the page. Defaults to 25.
last Int	Number of items to take from the end of the page. Cannot be combined with first.
after String	Return the items that follow this cursor.
before String	Return the items that precede this cursor.

PaymentDomain

Selection of the payments an operation applies to, expressed as search filters.

Arguments

Name	Description
filters PaymentFiltersInput	Apply the operation to every payment matching these filters.
ids [Int!]	Apply the operation to these payments only. Takes precedence over filters when both are sent.

PaymentFiltersInput

Search filters for payments. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the data of the supporter and the codes of the donation.
supporter Int	Keep only the payments of this supporter.
donation Int	Keep only the payments of this donation.
paymentMethod Int	Keep only the payments collected with this method.
paymentDate DateRange	Keep only payments collected in this range.
state [PaymentState!]	Keep only payments in these states.
order String	Field to sort by, prefixed with - for descending order.
createDate DateRange	Keep only payments created in this range.
updateDate DateRange	Keep only payments last modified in this range.

PeerCampaignFilters

Search filters for peer-to-peer pages. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the title of the page and the name of the fundraiser.
ids [Int!]	Restrict the results to these pages.
order String	Field to sort by, prefixed with - for descending order.
tags [String!]	Keep only pages carrying at least one of these labels.
tagsNot [String!]	Drop the pages carrying all of these labels.
channels [String!]	Keep only pages offered on these applications (channels).
supporterId Int	Keep only the pages of this fundraiser.
campaignId Int	Keep only the pages collecting for this campaign.

PeerCampaignInput

Fields of a peer-to-peer page that can be written. The supporter and the parent campaign are required; everything else is optional and left untouched when omitted.

Arguments

Name	Description
supporterId Int!	Supporter who is fundraising.
campaignId Int!	Campaign the page collects for.
title String	Title of the page.
content String	Body of the page, as HTML.
visibility WebDocumentVisibility	Whether the page is public, reachable only by direct link, or hidden.
slug String	URL segment of the page. Generated from the title when omitted.
seoTitle String	Title used by search engines.
seoDescription String	Meta description used by search engines and link previews.
template String	Name of the theme template rendering the page.
thankyouTemplate String	Name of the theme template rendering the thank-you page.
coverId Int	Media used as cover image of the page.
isGoalEnabled Boolean	Whether the goal and its progress bar are shown on the page.
goal Float	Amount the fundraiser aims to raise.
supporterName String	Name of the fundraiser as shown on the page.
customMessage String	Personal appeal written by the fundraiser.
receiptNotificationId Int	Notification used to send the receipt for donations collected on this page.

PrivacyDefinitionCreateInput

A consent to add to the ones the organization asks donors for.

Arguments

Name	Description
code String!	Stable code the consent is recorded under. Must be unique inside the organization.
label String!	Short label shown next to the checkbox.
message String	Full text of the consent.
isDefault Boolean	Whether the consent is asked on every donation form by default.
isRequired Boolean	Whether the donor must give the consent to be able to donate.
consentScopes [String!]	Marketing permissions the consent grants.

PrivacyDefinitionFilters

Search filters for consent definitions. Filters are combined with a logical AND.

Arguments

Name	Description
code String	Keep only the consent with this code.
label String	Keep only consents whose label matches.
isDefault Boolean	Keep only the consents asked by default, or only the others.
isRequired Boolean	Keep only the mandatory consents, or only the optional ones.

PrivacyDefinitionUpdateInput

Fields of a consent definition that can be changed. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
code String	Stable code the consent is recorded under.
label String	Short label shown next to the checkbox.
message String	Full text of the consent.
isDefault Boolean	Whether the consent is asked on every donation form by default.
isRequired Boolean	Whether the donor must give the consent to be able to donate.
consentScopes [String!]	Marketing permissions the consent grants.

ProjectFilters

Search filters for projects. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over the title and the content of the project.
order String	Field to sort by, prefixed with - for descending order.

ProjectInput

Fields of a project that can be written, its public page included. Every field is optional: omitted fields are left untouched.

Arguments

Name	Description
title String!	Title of the project page.
content String	Body of the project page, as HTML.
visibility WebDocumentVisibility	Whether the page is public, reachable only by direct link, or hidden.
slug String	URL segment of the page. Generated from the title when omitted.
seoTitle String	Title used by search engines.
seoDescription String	Meta description used by search engines and link previews.
template String	Name of the theme template rendering the page.
coverId Int	Media used as cover image of the page.
type ProjectType	How the campaigns are chosen: listed by hand or matched by rules.
rulesMatch ProjectRuleMatchType	Whether a campaign must satisfy every rule or just one of them.
campaignsOrder ProjectCampaignsOrder	Order the campaigns are listed in.
rules [ProjectRuleInput!]	Full replacement of the rules of the project.

ProjectRuleInput

A condition to add to a project. The list sent on ProjectInput.rules replaces the existing one, and rules are matched by uuid.

Arguments

Name	Description
field ProjectRuleField!	Field of the campaign the rule looks at.
operator ProjectRuleOperator!	How the field is compared with the value.
value String!	Value the field is compared with.
uuid String!	Stable identifier of the rule. Send the existing one to update a rule, a new one to add it.

RedirectInput

The path to redirect and where to send it.

Arguments

Name	Description
sourcePath String!	Path on the site to redirect, leading slash included.
destinationUrl String!	Address visitors are sent to.

RedirectsFiltersInput

Search filters for redirects.

Arguments

Name	Description
q String	Free-text search over the path and the destination of the redirect.

SegmentFiltersInput

Search filters for saved segments. Filters are combined with a logical AND.

Arguments

Name	Description
entity SegmentEntity!	Keep only the segments searching over this kind of record.
q String	Free-text search over the name of the segment.
order String	Field to sort by, prefixed with - for descending order.

SegmentInput

Name, kind of record and filters of a saved segment.

Arguments

Name	Description
name String!	Name of the segment.
entity SegmentEntity!	Kind of record the segment searches over.
filters String!	Filters of the segment, as a JSON string in the shape taken by the search of that record.

StripePaymentTypeInput

Which Stripe payment methods the intent must accept.

Arguments

Name	Description
types [StripePaymentType!]!	Payment methods the intent must accept. Defaults to the ones enabled for the organization.

SumUpAccountInput

The SumUp merchant to collect payments for.

Arguments

Name	Description
merchantCode String	Code of the merchant on SumUp. Null to disconnect the account.

SupporterDomain

Selection of the supporters an operation applies to, expressed as search filters.

Arguments

Name	Description
filters SupporterFiltersInput	Apply the operation to every supporter matching these filters.
ids [Int!]	Apply the operation to these supporters only. Takes precedence over filters when both are sent.

SupporterFiltersInput

Search filters for supporters. Filters are combined with a logical AND.

Arguments

Name	Description
q String	Free-text search over name, business name, email, phone, tax identifiers, postal code and address.
archived Boolean	Whether to return archived supporters, active ones, or both when omitted.
ids [Int!]	Restrict the results to these supporters.
order String	Field to sort by, prefixed with - for descending order.
type SupporterType	Keep only supporters of this nature.
city String	Keep only supporters whose city matches.
country String	Keep only supporters whose country matches.
createDate DateRange	Keep only supporters created in this range.
updateDate DateRange	Keep only supporters last modified in this range.
sex SexFilter	Keep only supporters of this gender, NOT_SPECIFIED matching the ones with none recorded.
campaigns [Int!]	Keep only supporters who gave to, or were acquired through, these campaigns.
firstDonationDate DateRange	Keep only supporters whose first donation falls in this range.
lastDonationDate DateRange	Keep only supporters whose last donation falls in this range.
totalDonated IntRange	Keep only supporters whose total given falls in this range.
totalDonations IntRange	Keep only supporters whose number of donations falls in this range.
peerCampaigns [Int!]	Keep only supporters who gave through these peer-to-peer pages.
havePhone Boolean	Keep only supporters with, or without, a phone number.
haveEmail Boolean	Keep only supporters with, or without, an email address.
haveVat Boolean	Keep only supporters with, or without, a VAT number.
haveSsn Boolean	Keep only supporters with, or without, a national tax identifier.
dateOfBirth DateRange	Keep only supporters born in this range.
placeOfBirth String	Keep only supporters born in this place.
emailMarketing Boolean	Keep only supporters who did, or did not, consent to marketing by email.
phoneMarketing Boolean	Keep only supporters who did, or did not, consent to marketing by phone.
smsMarketing Boolean	Keep only supporters who did, or did not, consent to marketing by SMS.
postalMarketing Boolean	Keep only supporters who did, or did not, consent to marketing by post.
profilationMarketing Boolean	Keep only supporters who did, or did not, consent to profiling.
privacyValues [String!]	Keep only supporters who accepted every consent with these codes.
tags [String!]	Keep only supporters carrying at least one of these labels.
tagsNot [String!]	Drop the supporters carrying all of these labels.
isOneoffSupporter Boolean	Keep only supporters who gave one-off donations.
isRegularSupporter Boolean	Keep only supporters with a recurring pledge.
email String	Keep only the supporter with exactly this email address.
ssn String	Keep only the supporter with exactly this national tax identifier.
phone String	Keep only supporters whose landline or mobile contains this text.
customfields [CustomFieldEntityFilter!]	Keep only supporters whose custom fields match these conditions.
importRuns [Int!]	Keep only supporters created by these import runs.
channels [Int!]	Keep only supporters acquired through these applications (channels).
query String	Advanced search written in the DjangoQL query language, for conditions the other filters cannot express.

SupporterInput

Fields of a supporter that can be written. Every field is optional: omitted fields are left untouched, so the same input works for creation and update.

Arguments

Name	Description
businessName String	Legal name of the company, family or group.
firstName String	Given name.
lastName String	Family name.
title String	Courtesy title, such as Dr. or Prof.
externalRef String	Identifier of the supporter in the external system they come from. Must be unique inside the organization.
supporterType SupporterType	Nature of the supporter, which decides whether the personal or the business fields apply.
email String	Main email address, used for receipts and notifications.
phone String	Landline number.
mobile String	Mobile number, used for SMS notifications.
job String	Job or role declared by the supporter.
sex Sex	Gender recorded on the supporter.
dateOfBirth Date	Date of birth, required by some tax receipt regimes.
placeOfBirth String	Place of birth, required by some tax receipt regimes.
ssn String	National tax identifier of the person (in Italy, the codice fiscale).
vat String	VAT number of the company.
address String	Street address.
address2 String	Second address line, for care-of details or the like.
city String	City of the address.
locality String	Locality or province of the address.
country String	Country of the address.
postalCode String	Postal code of the address.
emailMarketing Boolean	Consent to receive marketing messages by email.
phoneMarketing Boolean	Consent to be contacted for marketing by phone.
smsMarketing Boolean	Consent to receive marketing messages by SMS.
postalMarketing Boolean	Consent to receive marketing material by post.
profilationMarketing Boolean	Consent to have their data profiled for marketing purposes.
note String	Internal note attached to the supporter.
certificationUrl String	URL of the signed acquisition document collected for the supporter.
image String	URL of the profile picture to attach to the supporter.
tags [String!]	Full replacement of the labels attached to the supporter.
customfields [CustomFieldInput!]	Values of the custom fields defined by the organization for supporters.
privacyValues [SupporterPrivacyInput!]	Consents to record on the supporter, one entry per privacy definition.
sourceCampaignId Int	Campaign the supporter was acquired through.
sourcePeerCampaignId Int	Peer-to-peer page the supporter was acquired through.

SupporterPrivacyInput

A consent to record on a supporter, referring to one of the privacy definitions of the organization.

Arguments

Name	Description
code String!	Code of the privacy definition the consent refers to.
value Boolean!	Whether the consent was given.
date String	When the consent was collected, as an ISO 8601 string. Defaults to now when omitted.

TerminalLocationFilters

Search filters for the locations card readers are installed at.

Arguments

Name	Description
q String	Free-text search over the name of the location.

TerminalLocationInput

Address of a place card readers are installed at.

Arguments

Name	Description
displayName String!	Name of the location, shown in the back-office.
addressCity String!	City of the location.
addressCountry String!	Country of the location, as a two-letter code.
addressLine1 String!	Street address of the location.
addressLine2 String	Second address line of the location.
addressPostalCode String!	Postal code of the location.
addressState String!	State or province of the location.

TerminalRegisterInput

Data needed to pair a card reader with the Stripe account of the organization.

Arguments

Name	Description
label String!	Name of the reader, shown in the back-office.
registrationCode String!	Pairing code shown on the screen of the reader.
locationId String!	Location the reader is installed at.