Skip to main content

Input objects

ActivityCreateInput

Arguments

NameDescription
subject
ActivitySubject!
subjectId
Int!
category
ActivityCategory!
deadlineDate
Date
doneDate
Date
note
String
staffId
Int!

ActivityFilters

Arguments

NameDescription
q
String
order
String
dueDate
DateRange
userId
Int
supporterId
Int
donationId
Int

ActivityUpdateInput

Arguments

NameDescription
category
ActivityCategory
deadlineDate
Date
doneDate
Date
note
String
staffId
Int

ArticleInput

Arguments

NameDescription
title
String
content
String
visibility
WebDocumentVisibility
slug
String
seoTitle
String
seoDescription
String
template
String
coverId
Int
blogId
Int
customfields
[CustomFieldInput!]

ArticlesFiltersInput

Arguments

NameDescription
q
String

BlogInput

Arguments

NameDescription
title
String
content
String
visibility
WebDocumentVisibility
slug
String
seoTitle
String
seoDescription
String
template
String
coverId
Int
customfields
[CustomFieldInput!]

BlogsFiltersInput

Arguments

NameDescription
q
String

CampaignCommentsFilters

Arguments

NameDescription
q
String
supporterId
Int
campaignId
Int
status
CampaignCommentStatus

CampaignCommentUpdateInput

Arguments

NameDescription
message
String
status
CampaignCommentStatus
public
Boolean
anonymous
Boolean

CampaignFilters

Arguments

NameDescription
q
String
order
String
tags
[String!]
tagsNot
[String!]
channels
[String!]
ids
[Int!]
visibility
WebDocumentVisibility
customfields
[CustomFieldEntityFilter!]

CampaignInput

Arguments

NameDescription
title
String
content
String
visibility
WebDocumentVisibility
slug
String
seoTitle
String
seoDescription
String
template
String
thankyouTemplate
String
receiptNotificationId
Int
coverId
Int
isGoalEnabled
Boolean
code
String
goal
Float
type
CampaignType
tags
[String!]
excludedChannels
[Int!]
allowPeerToPeer
Boolean
costExamples
[CostExampleInput!]
customfields
[CustomFieldInput!]
hasOneOff
Boolean
hasSubscription
Boolean
hasSubscriptionCustomOptions
Boolean
defaultAmount
Float
minAmount
Float
maxAmount
Float
asks
[Float!]
allowCustomAmount
Boolean
defaultSubscriptionAmount
Float
minSubscriptionAmount
Float
maxSubscriptionAmount
Float
asksSubscription
[Float!]
allowCustomSubscriptionAmount
Boolean
shownFields
[String!]
requiredFields
[String!]
privacyFields
[String!]
privacyNote
String

CheckoutCompleteInput

Arguments

NameDescription
paymentMethodId
Int

CheckoutFilters

Arguments

NameDescription
q
String
state
CheckoutState
order
String
createDate
DateRange
updateDate
DateRange

CheckoutInput

Arguments

NameDescription
campaignId
Int
supporterId
Int
peerCampaignId
Int
amount
Float
frequency
Frequency
isPromise
Boolean
tags
[String!]
paymentMethodId
Int
supporterData
SupporterInput
donationData
DonationInput
device
String

CheckoutPaymentInput

Arguments

NameDescription
state
PaymentState
amount
Float
paymentDate
DateTime
donationId
Int
paymentMethodId
Int
peerCampaignId
Int
creditCardId
Int
sepaBankAccountId
Int
stripePaymentIntentId
String
satispayPaymentIntentId
String

CostExampleInput

Arguments

NameDescription
uuid
String!
name
String!
description
String!
amount
Float!
imageId
Int
monitorQuantity
Boolean!
quantity
Int!
availableQuantity
Int!

CustomFieldDefinitionCreateInput

Arguments

NameDescription
entity
CustomFieldEntity!
name
String!
key
String!
description
String
type
CustomFieldType!
position
Int
textUseChoices
Boolean
textChoices
[String!]
textMinLength
Int
textMaxLength
Int
decimalMinValue
Float
decimalMaxValue
Float
integerMinValue
Int
integerMaxValue
Int
dateMinValue
String
dateMaxValue
String
datetimeMinValue
String
datetimeMaxValue
String
hasSitefrontVisibility
Boolean
hidden
Boolean

CustomFieldDefinitionUpdateInput

Arguments

NameDescription
name
String
description
String
position
Int
textUseChoices
Boolean
textChoices
[String!]
textMinLength
Int
textMaxLength
Int
decimalMinValue
Float
decimalMaxValue
Float
integerMinValue
Int
integerMaxValue
Int
dateMinValue
String
dateMaxValue
String
datetimeMinValue
String
datetimeMaxValue
String
hasSitefrontVisibility
Boolean
hidden
Boolean

CustomFieldEntityFilter

Arguments

NameDescription
key
String!
value
String
operator
CustomFieldEntityFilterOperator!

CustomFieldFilters

Arguments

NameDescription
entity
CustomFieldEntity
hidden
Boolean

CustomFieldInput

Arguments

NameDescription
key
String!
value
String

DateRange

Arguments

NameDescription
start
Date
end
Date

DonationDomain

Arguments

NameDescription
filters
DonationFiltersInput
ids
[Int!]

DonationFiltersInput

Arguments

NameDescription
q
String
order
String
tags
[String!]
tagsNot
[String!]
createDate
DateRange
updateDate
DateRange
totalPaid
IntRange
totalPayments
IntRange
supporterType
SupporterType
campaigns
[Int!]
peerCampaigns
[Int!]
supporters
[Int!]
paymentMethods
[Int!]
frequencies
[Frequency!]

DonationInput

Arguments

NameDescription
amount
Float
frequency
Frequency
note
String
tags
[String!]
device
String
isPublic
Boolean
customfields
[CustomFieldInput!]

DonationPaymentInput

Arguments

NameDescription
amount
Float
frequency
Frequency
paymentDate
DateTime
paymentMethodId
Int

FormFilters

Arguments

NameDescription
q
String
order
String

FormInput

Arguments

NameDescription
name
String!
hasOneOff
Boolean
hasSubscription
Boolean
hasSubscriptionCustomOptions
Boolean
allowCustomAmount
Boolean
allowCustomSubscriptionAmount
Boolean
defaultAmount
Float
defaultSubscriptionAmount
Float
minAmount
Float
maxAmount
Float
minSubscriptionAmount
Float
maxSubscriptionAmount
Float
asks
[Float!]!
asksSubscription
[Float!]!
shownFields
[String!]!
requiredFields
[String!]!
note
String

IntRange

Arguments

NameDescription
start
Int
end
Int

ManualPaymentInput

Arguments

NameDescription
amount
Float!
paymentDate
DateTime!
paymentMethodId
Int

ManualPaymentMethodInput

Arguments

NameDescription
hasOneoffSupport
Boolean!
hasSubscriptionSupport
Boolean!
label
String!
description
String
instructions
String
channels
[Int!]!

Arguments

NameDescription
name
String!
handle
String!
items
[MenuItemInput!]!

Arguments

NameDescription
label
String!
link
String

OrganizationInput

Arguments

NameDescription
name
String!
logo
Int
legalName
String
currency
Currencies!
isInvoiceRequired
Boolean
vat
String
vatExchange
String
taxIdentificationNumber
String
senderEmail
String
contactEmail
String
contactPhone
String
addressLine1
String
addressLine2
String
city
String
state
String
country
String
postalCode
String

OrganizationLegalInput

Arguments

NameDescription
tos
String!
privacyPolicy
String!
consentScopes
[String!]!

OrganizationsFilters

Arguments

NameDescription
name
String

PageInput

Arguments

NameDescription
title
String
content
String
visibility
WebDocumentVisibility
slug
String
seoTitle
String
seoDescription
String
template
String
coverId
Int
customfields
[CustomFieldInput!]

PagesFiltersInput

Arguments

NameDescription
q
String

PaginationInput

Arguments

NameDescription
first
Int
last
Int
after
String
before
String

PaymentDomain

Arguments

NameDescription
filters
PaymentFiltersInput
ids
[Int!]

PaymentFiltersInput

Arguments

NameDescription
q
String
supporter
Int
donation
Int
paymentMethod
Int
paymentDate
DateRange
state
[PaymentState!]
order
String
createDate
DateRange
updateDate
DateRange

PeerCampaignFilters

Arguments

NameDescription
q
String
ids
[Int!]
order
String
tags
[String!]
tagsNot
[String!]
channels
[String!]
supporterId
Int
campaignId
Int

PeerCampaignInput

Arguments

NameDescription
supporterId
Int!
campaignId
Int!
title
String
content
String
visibility
WebDocumentVisibility
slug
String
seoTitle
String
seoDescription
String
template
String
thankyouTemplate
String
coverId
Int
isGoalEnabled
Boolean
goal
Float
supporterName
String
customMessage
String
receiptNotificationId
Int

PrivacyDefinitionCreateInput

Arguments

NameDescription
code
String!
label
String!
message
String
isDefault
Boolean
isRequired
Boolean
consentScopes
[String!]

PrivacyDefinitionFilters

Arguments

NameDescription
code
String
label
String
isDefault
Boolean
isRequired
Boolean

PrivacyDefinitionUpdateInput

Arguments

NameDescription
code
String
label
String
message
String
isDefault
Boolean
isRequired
Boolean
consentScopes
[String!]

ProjectFilters

Arguments

NameDescription
q
String
order
String

ProjectInput

Arguments

NameDescription
title
String!
content
String
visibility
WebDocumentVisibility
slug
String
seoTitle
String
seoDescription
String
template
String
coverId
Int
type
ProjectType
rulesMatch
ProjectRuleMatchType
campaignsOrder
ProjectCampaignsOrder
rules
[ProjectRuleInput!]
customfields
[CustomFieldInput!]

ProjectRuleInput

Arguments

NameDescription
field
ProjectRuleField!
operator
ProjectRuleOperator!
value
String!
uuid
String!

RedirectInput

Arguments

NameDescription
sourcePath
String!
destinationUrl
String!

RedirectsFiltersInput

Arguments

NameDescription
q
String

SegmentFiltersInput

Arguments

NameDescription
entity
SegmentEntity!
q
String
order
String

SegmentInput

Arguments

NameDescription
name
String!
entity
SegmentEntity!
filters
String!

StripePaymentTypeInput

Arguments

NameDescription
types
[StripePaymentType!]!

SupporterDomain

Arguments

NameDescription
filters
SupporterFiltersInput
ids
[Int!]

SupporterFiltersInput

Arguments

NameDescription
q
String
ids
[Int!]
order
String
type
SupporterType
city
String
country
String
createDate
DateRange
updateDate
DateRange
sex
SexFilter
campaigns
[Int!]
firstDonationDate
DateRange
lastDonationDate
DateRange
totalDonated
IntRange
totalDonations
IntRange
peerCampaigns
[Int!]
havePhone
Boolean
haveEmail
Boolean
haveVat
Boolean
haveSsn
Boolean
dateOfBirth
DateRange
placeOfBirth
String
emailMarketing
Boolean
phoneMarketing
Boolean
smsMarketing
Boolean
postalMarketing
Boolean
profilationMarketing
Boolean
privacyValues
[String!]
tags
[String!]
tagsNot
[String!]
isOneoffSupporter
Boolean
isRegularSupporter
Boolean
email
String
customfields
[CustomFieldEntityFilter!]
query
String

SupporterInput

Arguments

NameDescription
businessName
String
firstName
String
lastName
String
title
String
externalRef
String
supporterType
SupporterType
email
String
phone
String
mobile
String
job
String
sex
Sex
dateOfBirth
Date
placeOfBirth
String
ssn
String
vat
String
address
String
address2
String
city
String
locality
String
country
String
postalCode
String
emailMarketing
Boolean
phoneMarketing
Boolean
smsMarketing
Boolean
postalMarketing
Boolean
profilationMarketing
Boolean
note
String
certificationUrl
String
image
String
tags
[String!]
customfields
[CustomFieldInput!]
privacyValues
[SupporterPrivacyInput!]
sourceCampaignId
Int
sourcePeerCampaignId
Int

SupporterPrivacyInput

Arguments

NameDescription
code
String!
value
Boolean!
date
String

TerminalLocationFilters

Arguments

NameDescription
q
String

TerminalLocationInput

Arguments

NameDescription
displayName
String!
addressCity
String!
addressCountry
String!
addressLine1
String!
addressLine2
String
addressPostalCode
String!
addressState
String!

TerminalRegisterInput

Arguments

NameDescription
label
String!
registrationCode
String!
locationId
String!