Your Welcome title here

Chuffed.org graphql schema

Contact

Engineering

engineering@chuffed.org

https://dev-portal.chuffed.org/support

License

Proprietary

Terms of Service

https://dev-portal.chuffed.org/terms

API Endpoints

https://chuffed.org/api/graphql

Version

1.0.0

Queries

`amplifyVendors`

Response

Returns [AmplifyVendor!]!

Example

Query

query amplifyVendors {
  amplifyVendors {
    id
    label
  }
}

Response

{
  "data": {
    "amplifyVendors": [
      {"id": 4, "label": "xyz789"}
    ]
  }
}

Queries

`campaign`

Response

Returns a Campaign

Arguments

Name	Description
`id` - `ID!`

Example

Query

query campaign($id: ID!) {
  campaign(id: $id) {
    id
    title
    status
    financialInformation {
      ...FinancialInformationFragment
    }
    slug
    target {
      ...MoneyNodeFragment
    }
    collected {
      ...MoneyNodeFragment
    }
    content
    url
    owner {
      ...UserFragment
    }
    ownerName
    teams {
      ...TeamFragment
    }
    fundraisers {
      ...FundraiserConnectionFragment
    }
    donations {
      ...DonationConnectionFragment
    }
    regularGivings {
      ...RegularGivingConnectionFragment
    }
    assets {
      ...AssetFragment
    }
    perks {
      ...PerkFragment
    }
    amplify {
      ...AmplifyFragment
    }
    donationForm {
      ...DonationFormFragment
    }
    matchedGivings {
      ...MatchedGivingFragment
    }
    giftAid {
      ...GiftAidFragment
    }
    trackingCodes {
      ...CampaignTrackingCodeFragment
    }
    comments {
      ...CommentConnectionFragment
    }
    createdAt
    settings {
      ...CampaignSettingsFragment
    }
    tax {
      ...CampaignTaxFragment
    }
    campCategory
    utm {
      ...UTMTagsFragment
    }
    acquisitionSource {
      ...AcquisitionSourceFragment
    }
    duration {
      ...CampaignDurationFragment
    }
    address {
      ...AddressFragment
    }
    teamMembers {
      ...TeamMemberFragment
    }
    userImage
    integrations {
      ...CampaignIntegrationFragment
    }
    amplifyStatus {
      ...CampaignAmplifyStatusFragment
    }
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "campaign": {
      "id": 4,
      "title": "xyz789",
      "status": "Live",
      "financialInformation": FinancialInformation,
      "slug": "xyz789",
      "target": MoneyNode,
      "collected": MoneyNode,
      "content": Markup,
      "url": "http://www.test.com/",
      "owner": User,
      "ownerName": "abc123",
      "teams": [Team],
      "fundraisers": FundraiserConnection,
      "donations": DonationConnection,
      "regularGivings": RegularGivingConnection,
      "assets": [Asset],
      "perks": [Perk],
      "amplify": Amplify,
      "donationForm": DonationForm,
      "matchedGivings": [MatchedGiving],
      "giftAid": GiftAid,
      "trackingCodes": [CampaignTrackingCode],
      "comments": CommentConnection,
      "createdAt": "2007-12-03",
      "settings": CampaignSettings,
      "tax": CampaignTax,
      "campCategory": "xyz789",
      "utm": UTMTags,
      "acquisitionSource": AcquisitionSource,
      "duration": CampaignDuration,
      "address": Address,
      "teamMembers": [TeamMember],
      "userImage": "abc123",
      "integrations": [CampaignIntegration],
      "amplifyStatus": CampaignAmplifyStatus
    }
  }
}

Queries

`campaignAmplifyReceipts`

Response

Returns a CampaignAmplifyReceiptConnection!

Arguments

Name	Description
`after` - `ID`
`campaignId` - `ID!`
`first` - `Int`

Example

Query

query campaignAmplifyReceipts(
  $after: ID,
  $campaignId: ID!,
  $first: Int
) {
  campaignAmplifyReceipts(
    after: $after,
    campaignId: $campaignId,
    first: $first
  ) {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CampaignAmplifyReceiptEdgeFragment
    }
  }
}

Variables

{
  "after": "4",
  "campaignId": 4,
  "first": 987
}

Response

{
  "data": {
    "campaignAmplifyReceipts": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "edges": [CampaignAmplifyReceiptEdge]
    }
  }
}

Queries

`campaignUpdates`

Response

Returns a CampaignUpdateConnection!

Arguments

Name	Description
`campaignId` - `ID!`
`first` - `Int`
`after` - `ID`
`before` - `ID`
`sort` - `[CampaignUpdateSortableInput!]`

Example

Query

query campaignUpdates(
  $campaignId: ID!,
  $first: Int,
  $after: ID,
  $before: ID,
  $sort: [CampaignUpdateSortableInput!]
) {
  campaignUpdates(
    campaignId: $campaignId,
    first: $first,
    after: $after,
    before: $before,
    sort: $sort
  ) {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CampaignUpdateEdgeFragment
    }
  }
}

Variables

{
  "campaignId": 4,
  "first": 987,
  "after": "4",
  "before": 4,
  "sort": [CampaignUpdateSortableInput]
}

Response

{
  "data": {
    "campaignUpdates": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "edges": [CampaignUpdateEdge]
    }
  }
}

Queries

`campaigns`

Response

Returns a CampaignConnection!

Arguments

Name	Description
`filter` - `CampaignFilterInput`
`first` - `Int`
`after` - `ID`

Example

Query

query campaigns(
  $filter: CampaignFilterInput,
  $first: Int,
  $after: ID
) {
  campaigns(
    filter: $filter,
    first: $first,
    after: $after
  ) {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...CampaignEdgeFragment
    }
  }
}

Variables

{
  "filter": CampaignFilterInput,
  "first": 987,
  "after": "4"
}

Response

{
  "data": {
    "campaigns": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "edges": [CampaignEdge]
    }
  }
}

Queries

`categories`

Response

Returns [Category!]!

Example

Query

query categories {
  categories {
    id
    slug
    title
    campaigns {
      ...CampaignConnectionFragment
    }
    assets {
      ...AssetFragment
    }
  }
}

Response

{
  "data": {
    "categories": [
      {
        "id": "4",
        "slug": "xyz789",
        "title": "abc123",
        "campaigns": CampaignConnection,
        "assets": [Asset]
      }
    ]
  }
}

Queries

`countries`

Response

Returns [Country!]!

Arguments

Name	Description
`filter` - `CountryFilterInput`

Example

Query

query countries($filter: CountryFilterInput) {
  countries(filter: $filter) {
    id
    name
    currency {
      ...CurrencyFragment
    }
  }
}

Variables

{"filter": CountryFilterInput}

Response

{
  "data": {
    "countries": [
      {
        "id": CountryISOCode,
        "name": "xyz789",
        "currency": Currency
      }
    ]
  }
}

Queries

`crmAction`

Response

Returns an CRMAction

Arguments

Name	Description
`id` - `ID!`

Example

Query

query crmAction($id: ID!) {
  crmAction(id: $id) {
    id
    description
    arguments {
      ...CRMActionArgumentFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "crmAction": {
      "id": "4",
      "description": "xyz789",
      "arguments": [CRMActionArgument]
    }
  }
}

Queries

`crmActions`

Response

Returns [CRMAction!]!

Example

Query

query crmActions {
  crmActions {
    id
    description
    arguments {
      ...CRMActionArgumentFragment
    }
  }
}

Response

{
  "data": {
    "crmActions": [
      {
        "id": 4,
        "description": "xyz789",
        "arguments": [CRMActionArgument]
      }
    ]
  }
}

Queries

`currencies`

Response

Returns [Currency!]!

Example

Query

query currencies {
  currencies {
    key
    name
    symbol
    fractional
    conversions {
      ...CurrencyConversionFragment
    }
  }
}

Response

{
  "data": {
    "currencies": [
      {
        "key": CurrencyISOCode,
        "name": "abc123",
        "symbol": "xyz789",
        "fractional": "abc123",
        "conversions": [CurrencyConversion]
      }
    ]
  }
}

Queries

`currency`

Response

Returns a Currency

Arguments

Name	Description
`id` - `CurrencyISOCode!`

Example

Query

query currency($id: CurrencyISOCode!) {
  currency(id: $id) {
    key
    name
    symbol
    fractional
    conversions {
      ...CurrencyConversionFragment
    }
  }
}

Variables

{"id": CurrencyISOCode}

Response

{
  "data": {
    "currency": {
      "key": CurrencyISOCode,
      "name": "abc123",
      "symbol": "xyz789",
      "fractional": "abc123",
      "conversions": [CurrencyConversion]
    }
  }
}

Queries

`disputes`

Response

Returns a DisputeConnection!

Example

Query

query disputes {
  disputes {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...DisputeEdgeFragment
    }
  }
}

Response

{
  "data": {
    "disputes": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "edges": [DisputeEdge]
    }
  }
}

Queries

`donation`

Response

Returns a Donation

Arguments

Name	Description
`id` - `ID!`

Example

Query

query donation($id: ID!) {
  donation(id: $id) {
    id
    hashId
    user {
      ...UserFragment
    }
    amount {
      ...MoneyNodeFragment
    }
    name
    createdAt
    source
    status
    visibility
    receipt {
      ...AssetFragment
    }
    campaign {
      ...CampaignFragment
    }
    fundraiser {
      ...FundraiserFragment
    }
    perk {
      ...ClaimedPerkFragment
    }
    paymentMethod {
      ...UserPaymentMethodFragment
    }
    regularGiving {
      ...RegularGivingFragment
    }
    tracking {
      ...CampaignTrackingCodeFragment
    }
    utm {
      ...UTMTagsFragment
    }
    ipAddress
    isRefunded
    giftAid {
      ...GiftAidFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "donation": {
      "id": "4",
      "hashId": 4,
      "user": User,
      "amount": MoneyNode,
      "name": "abc123",
      "createdAt": "2007-12-03",
      "source": "Online",
      "status": "Confirmed",
      "visibility": "Anonymous",
      "receipt": Asset,
      "campaign": Campaign,
      "fundraiser": Fundraiser,
      "perk": ClaimedPerk,
      "paymentMethod": UserPaymentMethod,
      "regularGiving": RegularGiving,
      "tracking": CampaignTrackingCode,
      "utm": UTMTags,
      "ipAddress": IPAddress,
      "isRefunded": false,
      "giftAid": GiftAid
    }
  }
}

Queries

`donationFee`

Response

Returns a DonationFee

Arguments

Name	Description
`input` - `DonationFeeInput!`

Example

Query

query donationFee($input: DonationFeeInput!) {
  donationFee(input: $input) {
    fee {
      ...MoneyNodeFragment
    }
    tip {
      ...MoneyNodeFragment
    }
    donation {
      ...MoneyNodeFragment
    }
    totalPaid {
      ...MoneyNodeFragment
    }
    totalReceived {
      ...MoneyNodeFragment
    }
  }
}

Variables

{"input": DonationFeeInput}

Response

{
  "data": {
    "donationFee": {
      "fee": MoneyNode,
      "tip": MoneyNode,
      "donation": MoneyNode,
      "totalPaid": MoneyNode,
      "totalReceived": MoneyNode
    }
  }
}

Queries

`donations`

Response

Returns a DonationConnection!

Arguments

Name	Description
`filter` - `DonationFilterInput`
`first` - `Int`
`after` - `ID`
`sort` - `[DonationSortableInput!]`

Example

Query

query donations(
  $filter: DonationFilterInput,
  $first: Int,
  $after: ID,
  $sort: [DonationSortableInput!]
) {
  donations(
    filter: $filter,
    first: $first,
    after: $after,
    sort: $sort
  ) {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...DonationEdgeFragment
    }
  }
}

Variables

{
  "filter": DonationFilterInput,
  "first": 123,
  "after": "4",
  "sort": [DonationSortableInput]
}

Response

{
  "data": {
    "donations": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "edges": [DonationEdge]
    }
  }
}

Queries

`feeStructure`

use donationFee query instead

Response

Returns a FeeStructure

Arguments

Name	Description
`country` - `CountryISOCode!`

Example

Query

query feeStructure($country: CountryISOCode!) {
  feeStructure(country: $country) {
    country {
      ...CountryFragment
    }
    currency {
      ...CurrencyFragment
    }
    state
  }
}

Variables

{"country": CountryISOCode}

Response

{
  "data": {
    "feeStructure": {
      "country": Country,
      "currency": Currency,
      "state": Object
    }
  }
}

Queries

`fundraiser`

Response

Returns a Fundraiser

Arguments

Name	Description
`id` - `ID!`

Example

Query

query fundraiser($id: ID!) {
  fundraiser(id: $id) {
    id
    campaign {
      ...CampaignFragment
    }
    status
    team {
      ...TeamFragment
    }
    owner {
      ...UserFragment
    }
    title
    content
    slug
    target {
      ...MoneyNodeFragment
    }
    collected {
      ...MoneyNodeFragment
    }
    video
    url
    donations {
      ...DonationConnectionFragment
    }
    assets {
      ...AssetFragment
    }
    fundraiserName
    fundraiserEmail
    fundraiserProfile
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "fundraiser": {
      "id": "4",
      "campaign": Campaign,
      "status": "Draft",
      "team": Team,
      "owner": User,
      "title": "abc123",
      "content": Markup,
      "slug": "xyz789",
      "target": MoneyNode,
      "collected": MoneyNode,
      "video": "http://www.test.com/",
      "url": "http://www.test.com/",
      "donations": DonationConnection,
      "assets": [Asset],
      "fundraiserName": "xyz789",
      "fundraiserEmail": Email,
      "fundraiserProfile": "http://www.test.com/"
    }
  }
}

Queries

`landingPages`

Response

Returns a LandingPageConnection!

Arguments

Name	Description
`filter` - `LandingPageFilterInput`
`first` - `Int`
`after` - `ID`

Example

Query

query landingPages(
  $filter: LandingPageFilterInput,
  $first: Int,
  $after: ID
) {
  landingPages(
    filter: $filter,
    first: $first,
    after: $after
  ) {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...LandingPageEdgeFragment
    }
  }
}

Variables

{
  "filter": LandingPageFilterInput,
  "first": 987,
  "after": "4"
}

Response

{
  "data": {
    "landingPages": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "edges": [LandingPageEdge]
    }
  }
}

Queries

`languages`

Response

Returns [Language!]!

Example

Query

query languages {
  languages {
    id
    csvFileUrl
    jsonFileUrl
  }
}

Response

{
  "data": {
    "languages": [
      {
        "id": "4",
        "csvFileUrl": "http://www.test.com/",
        "jsonFileUrl": "http://www.test.com/"
      }
    ]
  }
}

Queries

`movement`

Response

Returns a Movement

Arguments

Name	Description
`id` - `ID!`

Example

Query

query movement($id: ID!) {
  movement(id: $id) {
    id
    title
    heading
    description
    slug
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "movement": {
      "id": "4",
      "title": "xyz789",
      "heading": "xyz789",
      "description": "xyz789",
      "slug": "abc123"
    }
  }
}

Queries

`movements`

Response

Returns a MovementConnection!

Arguments

Name	Description
`first` - `Int`
`after` - `ID`

Example

Query

query movements(
  $first: Int,
  $after: ID
) {
  movements(
    first: $first,
    after: $after
  ) {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...MovementEdgeFragment
    }
  }
}

Variables

{"first": 987, "after": 4}

Response

{
  "data": {
    "movements": {
      "totalCount": 123,
      "pageInfo": PageInfo,
      "edges": [MovementEdge]
    }
  }
}

Queries

`paymentPrefill`

Response

Returns a RegularGiving

Arguments

Name	Description
`input` - `PaymentPrefillInput!`

Example

Query

query paymentPrefill($input: PaymentPrefillInput!) {
  paymentPrefill(input: $input) {
    id
    donations {
      ...DonationConnectionFragment
    }
    frequency
    user {
      ...UserFragment
    }
    campaign {
      ...CampaignFragment
    }
    fundraiser {
      ...FundraiserFragment
    }
    status
    nextPaymentAt
    startAt
    endAt
    amount {
      ...MoneyNodeFragment
    }
    optionalDonation {
      ...MoneyNodeFragment
    }
    fees {
      ...MoneyNodeFragment
    }
    perk {
      ...ClaimedPerkFragment
    }
    paymentMethod {
      ...UserPaymentMethodFragment
    }
    schedules {
      ...ScheduleFragment
    }
  }
}

Variables

{"input": PaymentPrefillInput}

Response

{
  "data": {
    "paymentPrefill": {
      "id": 4,
      "donations": DonationConnection,
      "frequency": "Weekly",
      "user": User,
      "campaign": Campaign,
      "fundraiser": Fundraiser,
      "status": "Created",
      "nextPaymentAt": "2007-12-03",
      "startAt": "2007-12-03",
      "endAt": "2007-12-03",
      "amount": MoneyNode,
      "optionalDonation": MoneyNode,
      "fees": MoneyNode,
      "perk": ClaimedPerk,
      "paymentMethod": UserPaymentMethod,
      "schedules": [Schedule]
    }
  }
}

Queries

`perk`

Response

Returns a Perk

Arguments

Name	Description
`id` - `ID!`

Example

Query

query perk($id: ID!) {
  perk(id: $id) {
    id
    campaign {
      ...CampaignFragment
    }
    title
    amount {
      ...MoneyNodeFragment
    }
    description
    useImage
    assets {
      ...AssetFragment
    }
    delivery
    questions {
      ...PerkQuestionFragment
    }
    isQuestionEnabled
    isPublished
    isHidden
    quantity {
      ...PerkQuantityFragment
    }
    frequency {
      ...PerkRedemptionFrequencyFragment
    }
    allowMultiple
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "perk": {
      "id": "4",
      "campaign": Campaign,
      "title": "xyz789",
      "amount": MoneyNode,
      "description": "abc123",
      "useImage": false,
      "assets": [Asset],
      "delivery": "xyz789",
      "questions": [PerkQuestion],
      "isQuestionEnabled": true,
      "isPublished": false,
      "isHidden": false,
      "quantity": PerkQuantity,
      "frequency": PerkRedemptionFrequency,
      "allowMultiple": true
    }
  }
}

Queries

`recipient`

Response

Returns a Recipient

Arguments

Name	Description
`type` - `String!`
`id` - `ID!`

Example

Query

query recipient(
  $type: String!,
  $id: ID!
) {
  recipient(
    type: $type,
    id: $id
  ) {
    id
    url
    title
    assets {
      ...AssetFragment
    }
  }
}

Variables

{"type": "abc123", "id": 4}

Response

{
  "data": {
    "recipient": {
      "id": 4,
      "url": "http://www.test.com/",
      "title": "abc123",
      "assets": [Asset]
    }
  }
}

Queries

`regularGiving`

Response

Returns a RegularGiving

Arguments

Name	Description
`id` - `ID!`

Example

Query

query regularGiving($id: ID!) {
  regularGiving(id: $id) {
    id
    donations {
      ...DonationConnectionFragment
    }
    frequency
    user {
      ...UserFragment
    }
    campaign {
      ...CampaignFragment
    }
    fundraiser {
      ...FundraiserFragment
    }
    status
    nextPaymentAt
    startAt
    endAt
    amount {
      ...MoneyNodeFragment
    }
    optionalDonation {
      ...MoneyNodeFragment
    }
    fees {
      ...MoneyNodeFragment
    }
    perk {
      ...ClaimedPerkFragment
    }
    paymentMethod {
      ...UserPaymentMethodFragment
    }
    schedules {
      ...ScheduleFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "regularGiving": {
      "id": 4,
      "donations": DonationConnection,
      "frequency": "Weekly",
      "user": User,
      "campaign": Campaign,
      "fundraiser": Fundraiser,
      "status": "Created",
      "nextPaymentAt": "2007-12-03",
      "startAt": "2007-12-03",
      "endAt": "2007-12-03",
      "amount": MoneyNode,
      "optionalDonation": MoneyNode,
      "fees": MoneyNode,
      "perk": ClaimedPerk,
      "paymentMethod": UserPaymentMethod,
      "schedules": [Schedule]
    }
  }
}

Queries

`regularGivingFrequencyDates`

Response

Returns [RegularGivingFrequencyDate!]!

Arguments

Name	Description
`date` - `Date`

Example

Query

query regularGivingFrequencyDates($date: Date) {
  regularGivingFrequencyDates(date: $date) {
    frequency
    nextPaymentAt
  }
}

Variables

{"date": "2007-12-03"}

Response

{
  "data": {
    "regularGivingFrequencyDates": [
      {
        "frequency": "Weekly",
        "nextPaymentAt": "2007-12-03"
      }
    ]
  }
}

Queries

`settings`

Response

Returns a Settings!

Example

Query

query settings {
  settings {
    vendor {
      ...SettingsVendorFragment
    }
  }
}

Response

{"data": {"settings": {"vendor": SettingsVendor}}}

Queries

`survey`

Response

Returns a Survey

Arguments

Name	Description
`id` - `ID!`

Example

Query

query survey($id: ID!) {
  survey(id: $id) {
    id
    campaign {
      ...CampaignFragment
    }
    netPromoterScore
    bestExperience
    worstExperience
    isCompleted
    triggeredBy
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "survey": {
      "id": 4,
      "campaign": Campaign,
      "netPromoterScore": 123,
      "bestExperience": "abc123",
      "worstExperience": "abc123",
      "isCompleted": false,
      "triggeredBy": "CampaignCompleted"
    }
  }
}

Queries

`translationKeys`

Response

Returns [TranslationKey!]!

Example

Query

query translationKeys {
  translationKeys {
    id
  }
}

Response

{"data": {"translationKeys": [{"id": "4"}]}}

Queries

`translations`

Response

Returns [Translation!]!

Arguments

Name	Description
`languageId` - `ID!`

Example

Query

query translations($languageId: ID!) {
  translations(languageId: $languageId) {
    key {
      ...TranslationKeyFragment
    }
    language {
      ...LanguageFragment
    }
    translation
  }
}

Variables

{"languageId": 4}

Response

{
  "data": {
    "translations": [
      {
        "key": TranslationKey,
        "language": Language,
        "translation": "xyz789"
      }
    ]
  }
}

Queries

`user`

Response

Returns a User

Arguments

Name	Description
`id` - `ID!`

Example

Query

query user($id: ID!) {
  user(id: $id) {
    id
    email
    title
    firstName
    lastName
    phone
    address {
      ...AddressFragment
    }
    profileImage
    isAdmin
    isVerified
    isAutoApproved
    donations {
      ...DonationConnectionFragment
    }
    regularGivings {
      ...RegularGivingFragment
    }
    paymentMethods {
      ...UserPaymentMethodFragment
    }
    comments {
      ...CommentConnectionFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "user": {
      "id": 4,
      "email": Email,
      "title": "xyz789",
      "firstName": "xyz789",
      "lastName": "abc123",
      "phone": Phone,
      "address": Address,
      "profileImage": "http://www.test.com/",
      "isAdmin": true,
      "isVerified": true,
      "isAutoApproved": false,
      "donations": DonationConnection,
      "regularGivings": [RegularGiving],
      "paymentMethods": [UserPaymentMethod],
      "comments": CommentConnection
    }
  }
}

Queries

`userExists`

Response

Returns a UserExistsPayload!

Arguments

Name	Description
`email` - `Email!`

Example

Query

query userExists($email: Email!) {
  userExists(email: $email) {
    ok
  }
}

Variables

{"email": Email}

Response

{"data": {"userExists": {"ok": true}}}

Queries

`users`

Response

Returns a UserConnection!

Arguments

Name	Description
`filter` - `UserFilterInput`
`first` - `Int`
`after` - `ID`

Example

Query

query users(
  $filter: UserFilterInput,
  $first: Int,
  $after: ID
) {
  users(
    filter: $filter,
    first: $first,
    after: $after
  ) {
    totalCount
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...UserEdgeFragment
    }
  }
}

Variables

{
  "filter": UserFilterInput,
  "first": 987,
  "after": "4"
}

Response

{
  "data": {
    "users": {
      "totalCount": 987,
      "pageInfo": PageInfo,
      "edges": [UserEdge]
    }
  }
}

Queries

`viewer`

Response

Returns a User

Example

Query

query viewer {
  viewer {
    id
    email
    title
    firstName
    lastName
    phone
    address {
      ...AddressFragment
    }
    profileImage
    isAdmin
    isVerified
    isAutoApproved
    donations {
      ...DonationConnectionFragment
    }
    regularGivings {
      ...RegularGivingFragment
    }
    paymentMethods {
      ...UserPaymentMethodFragment
    }
    comments {
      ...CommentConnectionFragment
    }
  }
}

Response

{
  "data": {
    "viewer": {
      "id": "4",
      "email": Email,
      "title": "abc123",
      "firstName": "abc123",
      "lastName": "abc123",
      "phone": Phone,
      "address": Address,
      "profileImage": "http://www.test.com/",
      "isAdmin": true,
      "isVerified": false,
      "isAutoApproved": true,
      "donations": DonationConnection,
      "regularGivings": [RegularGiving],
      "paymentMethods": [UserPaymentMethod],
      "comments": CommentConnection
    }
  }
}

Queries

`webhooks`

Response

Returns [Webhook!]!

Example

Query

query webhooks {
  webhooks {
    id
    url
    description
    events {
      ...WebhookEventFragment
    }
    attempts {
      ...WebhookAttemptFragment
    }
  }
}

Response

{
  "data": {
    "webhooks": [
      {
        "id": 4,
        "url": "http://www.test.com/",
        "description": "xyz789",
        "events": [WebhookEvent],
        "attempts": [WebhookAttempt]
      }
    ]
  }
}

Mutations

`approveCampaign`

Response

Returns an ApproveCampaignPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation approveCampaign($id: ID!) {
  approveCampaign(id: $id) {
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"id": "4"}

Response

{"data": {"approveCampaign": {"campaign": Campaign}}}

Mutations

`associateAsset`

Response

Returns an AssociateAssetPayload

Arguments

Name	Description
`input` - `AssociateAssetInput!`

Example

Query

mutation associateAsset($input: AssociateAssetInput!) {
  associateAsset(input: $input) {
    asset {
      ...AssetFragment
    }
    assetsOwner {
      ...AssetsOwnerFragment
    }
  }
}

Variables

{"input": AssociateAssetInput}

Response

{
  "data": {
    "associateAsset": {
      "asset": Asset,
      "assetsOwner": AssetsOwner
    }
  }
}

Mutations

`associateCampaignAsset`

Response

Returns an AssociateCampaignAssetPayload

Arguments

Name	Description
`input` - `AssociateCampaignAssetInput!`

Example

Query

mutation associateCampaignAsset($input: AssociateCampaignAssetInput!) {
  associateCampaignAsset(input: $input) {
    asset {
      ...AssetFragment
    }
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"input": AssociateCampaignAssetInput}

Response

{
  "data": {
    "associateCampaignAsset": {
      "asset": Asset,
      "campaign": Campaign
    }
  }
}

Mutations

`associateDonationPerk`

Response

Returns an AssociateDonationPerkPayload

Arguments

Name	Description
`input` - `AssociateDonationPerkInput!`

Example

Query

mutation associateDonationPerk($input: AssociateDonationPerkInput!) {
  associateDonationPerk(input: $input) {
    donation {
      ...DonationFragment
    }
    perk {
      ...PerkFragment
    }
  }
}

Variables

{"input": AssociateDonationPerkInput}

Response

{
  "data": {
    "associateDonationPerk": {
      "donation": Donation,
      "perk": Perk
    }
  }
}

Mutations

`attachWebhookEvent`

Response

Returns an AttachWebhookEventPayload

Arguments

Name	Description
`input` - `AttachWebhookEventInput!`

Example

Query

mutation attachWebhookEvent($input: AttachWebhookEventInput!) {
  attachWebhookEvent(input: $input) {
    webhook {
      ...WebhookFragment
    }
  }
}

Variables

{"input": AttachWebhookEventInput}

Response

{"data": {"attachWebhookEvent": {"webhook": Webhook}}}

Mutations

`cancelRegularGiving`

Response

Returns a CancelRegularGivingPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation cancelRegularGiving($id: ID!) {
  cancelRegularGiving(id: $id) {
    regularGiving {
      ...RegularGivingFragment
    }
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "cancelRegularGiving": {
      "regularGiving": RegularGiving
    }
  }
}

Mutations

`changeBacsCapabilityByCampaign`

Response

Returns a ChangeCampaignBacsCapabilityPayload

Arguments

Name	Description
`id` - `ID!`
`enabled` - `Boolean!`

Example

Query

mutation changeBacsCapabilityByCampaign(
  $id: ID!,
  $enabled: Boolean!
) {
  changeBacsCapabilityByCampaign(
    id: $id,
    enabled: $enabled
  ) {
    ok
    message
  }
}

Variables

{"id": 4, "enabled": false}

Response

{
  "data": {
    "changeBacsCapabilityByCampaign": {
      "ok": true,
      "message": "xyz789"
    }
  }
}

Mutations

`changeBacsCapabilityByUser`

Response

Returns a ChangeUserBacsCapabilityPayload

Arguments

Name	Description
`userId` - `ID!`
`enabled` - `Boolean!`

Example

Query

mutation changeBacsCapabilityByUser(
  $userId: ID!,
  $enabled: Boolean!
) {
  changeBacsCapabilityByUser(
    userId: $userId,
    enabled: $enabled
  ) {
    ok
    bacsAutoEnabled
    campaignErrors
    successfulCampaigns
  }
}

Variables

{"userId": "4", "enabled": false}

Response

{
  "data": {
    "changeBacsCapabilityByUser": {
      "ok": true,
      "bacsAutoEnabled": true,
      "campaignErrors": ["xyz789"],
      "successfulCampaigns": [4]
    }
  }
}

Mutations

`changeDonationRecipient`

Response

Returns a ChangeDonationRecipientPayload

Arguments

Name	Description
`input` - `ChangeDonationRecipientInput!`

Example

Query

mutation changeDonationRecipient($input: ChangeDonationRecipientInput!) {
  changeDonationRecipient(input: $input) {
    donation {
      ...DonationFragment
    }
  }
}

Variables

{"input": ChangeDonationRecipientInput}

Response

{
  "data": {
    "changeDonationRecipient": {"donation": Donation}
  }
}

Mutations

`changeRegularGivingRecipient`

Response

Returns a ChangeRegularGivingRecipientPayload

Arguments

Name	Description
`input` - `ChangeRegularGivingRecipientInput!`

Example

Query

mutation changeRegularGivingRecipient($input: ChangeRegularGivingRecipientInput!) {
  changeRegularGivingRecipient(input: $input) {
    regularGiving {
      ...RegularGivingFragment
    }
  }
}

Variables

{"input": ChangeRegularGivingRecipientInput}

Response

{
  "data": {
    "changeRegularGivingRecipient": {
      "regularGiving": RegularGiving
    }
  }
}

Mutations

`completeSurvey`

Response

Returns a CompleteSurveyPayload

Arguments

Name	Description
`input` - `CompleteSurveyInput!`

Example

Query

mutation completeSurvey($input: CompleteSurveyInput!) {
  completeSurvey(input: $input) {
    survey {
      ...SurveyFragment
    }
  }
}

Variables

{"input": CompleteSurveyInput}

Response

{"data": {"completeSurvey": {"survey": Survey}}}

Mutations

`confirmVerificationCode`

Response

Returns a ConfirmVerificationCodePayload

Arguments

Name	Description
`input` - `ConfirmVerificationCodeInput!`

Example

Query

mutation confirmVerificationCode($input: ConfirmVerificationCodeInput!) {
  confirmVerificationCode(input: $input) {
    verified
  }
}

Variables

{"input": ConfirmVerificationCodeInput}

Response

{"data": {"confirmVerificationCode": {"verified": true}}}

Mutations

`createAmplifyVendorCampaign`

Response

Returns a CreateAmplifyVendorCampaignPayload

Arguments

Name	Description
`input` - `CreateAmplifyVendorCampaignInput!`

Example

Query

mutation createAmplifyVendorCampaign($input: CreateAmplifyVendorCampaignInput!) {
  createAmplifyVendorCampaign(input: $input) {
    advert {
      ...AmplifyVendorCampaignFragment
    }
  }
}

Variables

{"input": CreateAmplifyVendorCampaignInput}

Response

{
  "data": {
    "createAmplifyVendorCampaign": {
      "advert": AmplifyVendorCampaign
    }
  }
}

Mutations

`createAsset`

Response

Returns a CreateAssetPayload

Arguments

Name	Description
`input` - `CreateAssetInput!`

Example

Query

mutation createAsset($input: CreateAssetInput!) {
  createAsset(input: $input) {
    asset {
      ...AssetFragment
    }
  }
}

Variables

{"input": CreateAssetInput}

Response

{"data": {"createAsset": {"asset": Asset}}}

Mutations

`createCampaign`

Response

Returns a CreateCampaignPayload

Arguments

Name	Description
`input` - `CreateCampaignInput!`

Example

Query

mutation createCampaign($input: CreateCampaignInput!) {
  createCampaign(input: $input) {
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"input": CreateCampaignInput}

Response

{"data": {"createCampaign": {"campaign": Campaign}}}

Mutations

`createCampaignAmplifyReceipt`

Response

Returns a CampaignAmplifyReceiptPayload

Arguments

Name	Description
`input` - `CreateCampaignAmplifyReceiptInput!`

Example

Query

mutation createCampaignAmplifyReceipt($input: CreateCampaignAmplifyReceiptInput!) {
  createCampaignAmplifyReceipt(input: $input) {
    receipt {
      ...CampaignAmplifyReceiptFragment
    }
  }
}

Variables

{"input": CreateCampaignAmplifyReceiptInput}

Response

{
  "data": {
    "createCampaignAmplifyReceipt": {
      "receipt": CampaignAmplifyReceipt
    }
  }
}

Mutations

`createCampaignTrackingCode`

Response

Returns a CreateCampaignTrackingCodePayload

Arguments

Name	Description
`input` - `CreateCampaignTrackingCodeInput!`

Example

Query

mutation createCampaignTrackingCode($input: CreateCampaignTrackingCodeInput!) {
  createCampaignTrackingCode(input: $input) {
    trackingCode {
      ...CampaignTrackingCodeFragment
    }
  }
}

Variables

{"input": CreateCampaignTrackingCodeInput}

Response

{
  "data": {
    "createCampaignTrackingCode": {
      "trackingCode": CampaignTrackingCode
    }
  }
}

Mutations

`createCampaignUpdate`

Response

Returns a CreateCampaignUpdatePayload

Arguments

Name	Description
`input` - `CreateCampaignUpdateInput!`

Example

Query

mutation createCampaignUpdate($input: CreateCampaignUpdateInput!) {
  createCampaignUpdate(input: $input) {
    ok
    campaignId
  }
}

Variables

{"input": CreateCampaignUpdateInput}

Response

{"data": {"createCampaignUpdate": {"ok": false, "campaignId": 4}}}

Mutations

`createDirectDebit`

Response

Returns a CreateDirectDebitPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation createDirectDebit($id: ID!) {
  createDirectDebit(id: $id) {
    session
    customer
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "createDirectDebit": {
      "session": "abc123",
      "customer": "abc123"
    }
  }
}

Mutations

`createDirectDebitRegularGiving`

Response

Returns a CreateDirectDebitRegularGivingPayload

Arguments

Name	Description
`input` - `CreateDirectDebitRegularGivingInput!`

Example

Query

mutation createDirectDebitRegularGiving($input: CreateDirectDebitRegularGivingInput!) {
  createDirectDebitRegularGiving(input: $input) {
    session
    customer
  }
}

Variables

{"input": CreateDirectDebitRegularGivingInput}

Response

{
  "data": {
    "createDirectDebitRegularGiving": {
      "session": "abc123",
      "customer": "xyz789"
    }
  }
}

Mutations

`createFundraiser`

Response

Returns a CreateFundraiserPayload

Arguments

Name	Description
`input` - `CreateFundraiserInput!`

Example

Query

mutation createFundraiser($input: CreateFundraiserInput!) {
  createFundraiser(input: $input) {
    fundraiser {
      ...FundraiserFragment
    }
  }
}

Variables

{"input": CreateFundraiserInput}

Response

{"data": {"createFundraiser": {"fundraiser": Fundraiser}}}

Mutations

`createLandingPage`

Response

Returns a CreateLandingPagePayload

Arguments

Name	Description
`input` - `CreateLandingPageInput!`

Example

Query

mutation createLandingPage($input: CreateLandingPageInput!) {
  createLandingPage(input: $input) {
    landingPage {
      ...LandingPageFragment
    }
  }
}

Variables

{"input": CreateLandingPageInput}

Response

{
  "data": {
    "createLandingPage": {"landingPage": LandingPage}
  }
}

Mutations

`createMovement`

Response

Returns a CreateMovementPayload

Arguments

Name	Description
`input` - `CreateMovementInput!`

Example

Query

mutation createMovement($input: CreateMovementInput!) {
  createMovement(input: $input) {
    movement {
      ...MovementFragment
    }
  }
}

Variables

{"input": CreateMovementInput}

Response

{"data": {"createMovement": {"movement": Movement}}}

Mutations

`createOfflineDonation`

Response

Returns a CreateOfflineDonationPayload

Arguments

Name	Description
`input` - `CreateOfflineDonationInput!`

Example

Query

mutation createOfflineDonation($input: CreateOfflineDonationInput!) {
  createOfflineDonation(input: $input) {
    donation {
      ...DonationFragment
    }
  }
}

Variables

{"input": CreateOfflineDonationInput}

Response

{
  "data": {
    "createOfflineDonation": {"donation": Donation}
  }
}

Mutations

`createSetupIntentRegularGiving`

Response

Returns a CreateSetupIntentRegularGivingPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation createSetupIntentRegularGiving($id: ID!) {
  createSetupIntentRegularGiving(id: $id) {
    regularGiving {
      ...RegularGivingFragment
    }
    token
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "createSetupIntentRegularGiving": {
      "regularGiving": RegularGiving,
      "token": "4"
    }
  }
}

Mutations

`createTeam`

Response

Returns a CreateTeamPayload

Arguments

Name	Description
`input` - `CreateTeamInput!`

Example

Query

mutation createTeam($input: CreateTeamInput!) {
  createTeam(input: $input) {
    team {
      ...TeamFragment
    }
  }
}

Variables

{"input": CreateTeamInput}

Response

{"data": {"createTeam": {"team": Team}}}

Mutations

`createTranslationKeys`

Response

Returns a CreateTranslationKeysPayload

Arguments

Name	Description
`id` - `[ID!]!`

Example

Query

mutation createTranslationKeys($id: [ID!]!) {
  createTranslationKeys(id: $id) {
    keys {
      ...TranslationKeyFragment
    }
  }
}

Variables

{"id": ["4"]}

Response

{
  "data": {
    "createTranslationKeys": {"keys": [TranslationKey]}
  }
}

Mutations

`createTranslationLanguage`

Response

Returns a CreateTranslationLanguagePayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation createTranslationLanguage($id: ID!) {
  createTranslationLanguage(id: $id) {
    language {
      ...LanguageFragment
    }
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "createTranslationLanguage": {"language": Language}
  }
}

Mutations

`createVerificationCode`

Response

Returns a CreateVerificationCodePayload

Arguments

Name	Description
`input` - `CreateVerificationCodeInput!`

Example

Query

mutation createVerificationCode($input: CreateVerificationCodeInput!) {
  createVerificationCode(input: $input) {
    key
    nextCodeAt
  }
}

Variables

{"input": CreateVerificationCodeInput}

Response

{
  "data": {
    "createVerificationCode": {
      "key": "abc123",
      "nextCodeAt": "xyz789"
    }
  }
}

Mutations

`createWebhook`

Response

Returns a CreateWebhookPayload

Arguments

Name	Description
`input` - `CreateWebhookInput!`

Example

Query

mutation createWebhook($input: CreateWebhookInput!) {
  createWebhook(input: $input) {
    webhook {
      ...WebhookFragment
    }
  }
}

Variables

{"input": CreateWebhookInput}

Response

{"data": {"createWebhook": {"webhook": Webhook}}}

Mutations

`deleteAsset`

Response

Returns a DeleteAssetPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteAsset($id: ID!) {
  deleteAsset(id: $id) {
    asset {
      ...AssetFragment
    }
  }
}

Variables

{"id": 4}

Response

{"data": {"deleteAsset": {"asset": Asset}}}

Mutations

`deleteCampaign`

Response

Returns a DeleteCampaignPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteCampaign($id: ID!) {
  deleteCampaign(id: $id) {
    ok
  }
}

Variables

{"id": "4"}

Response

{"data": {"deleteCampaign": {"ok": false}}}

Mutations

`deleteCampaignUpdate`

Response

Returns a DeleteCampaignUpdatePayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteCampaignUpdate($id: ID!) {
  deleteCampaignUpdate(id: $id) {
    ok
  }
}

Variables

{"id": 4}

Response

{"data": {"deleteCampaignUpdate": {"ok": false}}}

Mutations

`deleteOfflineDonation`

Response

Returns a DeleteOfflineDonationPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteOfflineDonation($id: ID!) {
  deleteOfflineDonation(id: $id) {
    donation {
      ...DonationFragment
    }
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "deleteOfflineDonation": {"donation": Donation}
  }
}

Mutations

`deleteUser`

Response

Returns a DeleteUserPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteUser($id: ID!) {
  deleteUser(id: $id) {
    ok
  }
}

Variables

{"id": 4}

Response

{"data": {"deleteUser": {"ok": false}}}

Mutations

`disassociateAsset`

Response

Returns a DisassociateAssetPayload

Arguments

Name	Description
`input` - `DisassociateAssetInput!`

Example

Query

mutation disassociateAsset($input: DisassociateAssetInput!) {
  disassociateAsset(input: $input) {
    asset {
      ...AssetFragment
    }
    assetsOwner {
      ...AssetsOwnerFragment
    }
  }
}

Variables

{"input": DisassociateAssetInput}

Response

{
  "data": {
    "disassociateAsset": {
      "asset": Asset,
      "assetsOwner": AssetsOwner
    }
  }
}

Mutations

`disassociateCampaignAsset`

Response

Returns a DisassociateCampaignAssetPayload

Arguments

Name	Description
`input` - `DisassociateCampaignAssetInput!`

Example

Query

mutation disassociateCampaignAsset($input: DisassociateCampaignAssetInput!) {
  disassociateCampaignAsset(input: $input) {
    asset {
      ...AssetFragment
    }
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"input": DisassociateCampaignAssetInput}

Response

{
  "data": {
    "disassociateCampaignAsset": {
      "asset": Asset,
      "campaign": Campaign
    }
  }
}

Mutations

`disassociateDonationPerk`

Response

Returns a DisassociateDonationPerkPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation disassociateDonationPerk($id: ID!) {
  disassociateDonationPerk(id: $id) {
    donation {
      ...DonationFragment
    }
    perk {
      ...PerkFragment
    }
  }
}

Variables

{"id": "4"}

Response

{
  "data": {
    "disassociateDonationPerk": {
      "donation": Donation,
      "perk": Perk
    }
  }
}

Mutations

`dispatchCampaignAmplifyReceipts`

Response

Returns a DispatchCampaignAmplifyReceiptsPayload

Arguments

Name	Description
`input` - `DispatchCampaignAmplifyReceiptsInput!`

Example

Query

mutation dispatchCampaignAmplifyReceipts($input: DispatchCampaignAmplifyReceiptsInput!) {
  dispatchCampaignAmplifyReceipts(input: $input) {
    receipts {
      ...CampaignAmplifyReceiptFragment
    }
  }
}

Variables

{"input": DispatchCampaignAmplifyReceiptsInput}

Response

{
  "data": {
    "dispatchCampaignAmplifyReceipts": {
      "receipts": [CampaignAmplifyReceipt]
    }
  }
}

Mutations

`dispatchEvent`

Response

Returns a DispatchEventPayload

Arguments

Name	Description
`input` - `DispatchEventInput!`

Example

Query

mutation dispatchEvent($input: DispatchEventInput!) {
  dispatchEvent(input: $input) {
    ok
  }
}

Variables

{"input": DispatchEventInput}

Response

{"data": {"dispatchEvent": {"ok": false}}}

Mutations

`executeCRMAction`

Response

Returns an ExecuteCRMActionPayload

Arguments

Name	Description
`input` - `ExecuteCRMActionInput!`

Example

Query

mutation executeCRMAction($input: ExecuteCRMActionInput!) {
  executeCRMAction(input: $input) {
    message
    status
    context
  }
}

Variables

{"input": ExecuteCRMActionInput}

Response

{
  "data": {
    "executeCRMAction": {
      "message": "abc123",
      "status": "Success",
      "context": Object
    }
  }
}

Mutations

`importTranslation`

Response

Returns an ImportTranslationPayload

Arguments

Name	Description
`input` - `ImportTranslationInput!`

Example

Query

mutation importTranslation($input: ImportTranslationInput!) {
  importTranslation(input: $input) {
    accepted
  }
}

Variables

{"input": ImportTranslationInput}

Response

{"data": {"importTranslation": {"accepted": false}}}

Mutations

`launchCampaign`

Response

Returns a LaunchCampaignPayload

Arguments

Name	Description
`input` - `LaunchCampaignInput!`

Example

Query

mutation launchCampaign($input: LaunchCampaignInput!) {
  launchCampaign(input: $input) {
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"input": LaunchCampaignInput}

Response

{"data": {"launchCampaign": {"campaign": Campaign}}}

Mutations

`linkCampaignTrackingCodeToAmplifyCampaign`

Response

Returns a LinkCampaignTrackingCodeToAmplifyCampaignPayload

Arguments

Name	Description
`input` - `LinkCampaignTrackingCodeToAmplifyCampaignInput!`

Example

Query

mutation linkCampaignTrackingCodeToAmplifyCampaign($input: LinkCampaignTrackingCodeToAmplifyCampaignInput!) {
  linkCampaignTrackingCodeToAmplifyCampaign(input: $input) {
    trackingCode {
      ...CampaignTrackingCodeFragment
    }
  }
}

Variables

{"input": LinkCampaignTrackingCodeToAmplifyCampaignInput}

Response

{
  "data": {
    "linkCampaignTrackingCodeToAmplifyCampaign": {
      "trackingCode": CampaignTrackingCode
    }
  }
}

Mutations

`linkFundraiserTeam`

Response

Returns a LinkFundraiserTeamPayload

Arguments

Name	Description
`input` - `LinkFundraiserTeamInput!`

Example

Query

mutation linkFundraiserTeam($input: LinkFundraiserTeamInput!) {
  linkFundraiserTeam(input: $input) {
    team {
      ...TeamFragment
    }
    fundraiser {
      ...FundraiserFragment
    }
  }
}

Variables

{"input": LinkFundraiserTeamInput}

Response

{
  "data": {
    "linkFundraiserTeam": {
      "team": Team,
      "fundraiser": Fundraiser
    }
  }
}

Mutations

`login`

Response

Returns a LoginPayload

Arguments

Name	Description
`input` - `LoginInput!`

Example

Query

mutation login($input: LoginInput!) {
  login(input: $input) {
    user {
      ...UserFragment
    }
    bearerToken
    intended
  }
}

Variables

{"input": LoginInput}

Response

{
  "data": {
    "login": {
      "user": User,
      "bearerToken": "xyz789",
      "intended": "http://www.test.com/"
    }
  }
}

Mutations

`loginAs`

Response

Returns a LoginAsPayload

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation loginAs($id: ID!) {
  loginAs(id: $id) {
    ok
    url
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "loginAs": {
      "ok": true,
      "url": "http://www.test.com/"
    }
  }
}

Mutations

`logout`

Response

Returns a LogoutPayload

Example

Query

mutation logout {
  logout {
    ok
  }
}

Response

{"data": {"logout": {"ok": true}}}

Mutations

`refundDonation`

Response

Returns a RefundDonationPayload

Arguments

Name	Description
`input` - `RefundDonationInput!`

Example

Query

mutation refundDonation($input: RefundDonationInput!) {
  refundDonation(input: $input) {
    donation {
      ...DonationFragment
    }
  }
}

Variables

{"input": RefundDonationInput}

Response

{"data": {"refundDonation": {"donation": Donation}}}

Mutations

`rejectCampaign`

Response

Returns a RejectCampaignPayload

Arguments

Name	Description
`input` - `RejectCampaignInput!`

Example

Query

mutation rejectCampaign($input: RejectCampaignInput!) {
  rejectCampaign(input: $input) {
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"input": RejectCampaignInput}

Response

{"data": {"rejectCampaign": {"campaign": Campaign}}}

Mutations

`reportCampaign`

Response

Returns a ReportCampaignPayload

Arguments

Name	Description
`input` - `ReportCampaignInput!`

Example

Query

mutation reportCampaign($input: ReportCampaignInput!) {
  reportCampaign(input: $input) {
    submitted
    message
  }
}

Variables

{"input": ReportCampaignInput}

Response

{
  "data": {
    "reportCampaign": {
      "submitted": false,
      "message": "abc123"
    }
  }
}

Mutations

`resetPassword`

Response

Returns a ResetPasswordPayload

Arguments

Name	Description
`email` - `Email!`

Example

Query

mutation resetPassword($email: Email!) {
  resetPassword(email: $email) {
    ok
  }
}

Variables

{"email": Email}

Response

{"data": {"resetPassword": {"ok": true}}}

Mutations

`revertCampaign`

Response

Returns a RevertCampaignPayload

Arguments

Name	Description
`input` - `RevertCampaignInput!`

Example

Query

mutation revertCampaign($input: RevertCampaignInput!) {
  revertCampaign(input: $input) {
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"input": RevertCampaignInput}

Response

{"data": {"revertCampaign": {"campaign": Campaign}}}

Mutations

`signup`

Response

Returns a SignupPayload

Arguments

Name	Description
`input` - `SignupInput!`

Example

Query

mutation signup($input: SignupInput!) {
  signup(input: $input) {
    user {
      ...UserFragment
    }
    ok
  }
}

Variables

{"input": SignupInput}

Response

{"data": {"signup": {"user": User, "ok": true}}}

Mutations

`syncCampaignIntegration`

Response

Returns a SyncCampaignIntegrationPayload

Arguments

Name	Description
`input` - `SyncCampaignIntegrationInput!`

Example

Query

mutation syncCampaignIntegration($input: SyncCampaignIntegrationInput!) {
  syncCampaignIntegration(input: $input) {
    campaign {
      ...CampaignFragment
    }
    ok
  }
}

Variables

{"input": SyncCampaignIntegrationInput}

Response

{
  "data": {
    "syncCampaignIntegration": {
      "campaign": Campaign,
      "ok": false
    }
  }
}

Mutations

`transferUserResources`

Response

Returns a TransferUserResourcesPayload

Arguments

Name	Description
`input` - `TransferUserResourcesInput!`

Example

Query

mutation transferUserResources($input: TransferUserResourcesInput!) {
  transferUserResources(input: $input) {
    recipient {
      ...UserFragment
    }
  }
}

Variables

{"input": TransferUserResourcesInput}

Response

{"data": {"transferUserResources": {"recipient": User}}}

Mutations

`unlinkCampaignTrackingCodeToAmplifyCampaign`

Response

Returns an UnlinkCampaignTrackingCodeToAmplifyCampaignPayload

Arguments

Name	Description
`input` - `UnlinkCampaignTrackingCodeToAmplifyCampaignInput!`

Example

Query

mutation unlinkCampaignTrackingCodeToAmplifyCampaign($input: UnlinkCampaignTrackingCodeToAmplifyCampaignInput!) {
  unlinkCampaignTrackingCodeToAmplifyCampaign(input: $input) {
    trackingCode {
      ...CampaignTrackingCodeFragment
    }
  }
}

Variables

{
  "input": UnlinkCampaignTrackingCodeToAmplifyCampaignInput
}

Response

{
  "data": {
    "unlinkCampaignTrackingCodeToAmplifyCampaign": {
      "trackingCode": CampaignTrackingCode
    }
  }
}

Mutations

`unlinkFundraiserTeam`

Response

Returns an UnlinkFundraiserTeamPayload

Arguments

Name	Description
`input` - `UnlinkFundraiserTeamInput!`

Example

Query

mutation unlinkFundraiserTeam($input: UnlinkFundraiserTeamInput!) {
  unlinkFundraiserTeam(input: $input) {
    team {
      ...TeamFragment
    }
    fundraiser {
      ...FundraiserFragment
    }
  }
}

Variables

{"input": UnlinkFundraiserTeamInput}

Response

{
  "data": {
    "unlinkFundraiserTeam": {
      "team": Team,
      "fundraiser": Fundraiser
    }
  }
}

Mutations

`updateCampaign`

Response

Returns an UpdateCampaignPayload

Arguments

Name	Description
`input` - `UpdateCampaignInput!`

Example

Query

mutation updateCampaign($input: UpdateCampaignInput!) {
  updateCampaign(input: $input) {
    campaign {
      ...CampaignFragment
    }
  }
}

Variables

{"input": UpdateCampaignInput}

Response

{"data": {"updateCampaign": {"campaign": Campaign}}}

Mutations

`updateCampaignAmplifyReceipt`

Response

Returns a CampaignAmplifyReceiptPayload

Arguments

Name	Description
`input` - `UpdateCampaignAmplifyReceiptInput!`

Example

Query

mutation updateCampaignAmplifyReceipt($input: UpdateCampaignAmplifyReceiptInput!) {
  updateCampaignAmplifyReceipt(input: $input) {
    receipt {
      ...CampaignAmplifyReceiptFragment
    }
  }
}

Variables

{"input": UpdateCampaignAmplifyReceiptInput}

Response

{
  "data": {
    "updateCampaignAmplifyReceipt": {
      "receipt": CampaignAmplifyReceipt
    }
  }
}

Mutations

`updateCampaignAmplifyStatus`

Response

Returns an UpdateCampaignAmplifyStatusPayload

Arguments

Name	Description
`input` - `UpdateCampaignAmplifyStatusInput!`

Example

Query

mutation updateCampaignAmplifyStatus($input: UpdateCampaignAmplifyStatusInput!) {
  updateCampaignAmplifyStatus(input: $input) {
    campaignAmplifyStatus {
      ...CampaignAmplifyStatusFragment
    }
  }
}

Variables

{"input": UpdateCampaignAmplifyStatusInput}

Response

{
  "data": {
    "updateCampaignAmplifyStatus": {
      "campaignAmplifyStatus": CampaignAmplifyStatus
    }
  }
}

Mutations

`updateCampaignDonationForm`

Response

Returns an UpdateCampaignDonationFormPayload

Arguments

Name	Description
`input` - `UpdateCampaignDonationFormInput!`

Example

Query

mutation updateCampaignDonationForm($input: UpdateCampaignDonationFormInput!) {
  updateCampaignDonationForm(input: $input) {
    campaign {
      ...CampaignFragment
    }
    donationForm {
      ...DonationFormFragment
    }
  }
}

Variables

{"input": UpdateCampaignDonationFormInput}

Response

{
  "data": {
    "updateCampaignDonationForm": {
      "campaign": Campaign,
      "donationForm": DonationForm
    }
  }
}

Mutations

`updateCampaignDonationFormTemplate`

Response

Returns an UpdateCampaignDonationFormTemplatePayload

Arguments

Name	Description
`input` - `UpdateCampaignDonationFormTemplateInput!`

Example

Query

mutation updateCampaignDonationFormTemplate($input: UpdateCampaignDonationFormTemplateInput!) {
  updateCampaignDonationFormTemplate(input: $input) {
    template
  }
}

Variables

{"input": UpdateCampaignDonationFormTemplateInput}

Response

{
  "data": {
    "updateCampaignDonationFormTemplate": {
      "template": DonationFormTemplate
    }
  }
}

Mutations

`updateCampaignIntegration`

Response

Returns an UpdateCampaignIntegrationPayload

Arguments

Name	Description
`input` - `UpdateCampaignIntegrationInput!`

Example

Query

mutation updateCampaignIntegration($input: UpdateCampaignIntegrationInput!) {
  updateCampaignIntegration(input: $input) {
    integration {
      ...CampaignIntegrationFragment
    }
  }
}

Variables

{"input": UpdateCampaignIntegrationInput}

Response

{
  "data": {
    "updateCampaignIntegration": {
      "integration": CampaignIntegration
    }
  }
}

Mutations

`updateCampaignSettings`

Response

Returns an UpdateCampaignSettingsPayload

Arguments

Name	Description
`input` - `UpdateCampaignSettingsInput!`

Example

Query

mutation updateCampaignSettings($input: UpdateCampaignSettingsInput!) {
  updateCampaignSettings(input: $input) {
    campaignSettings {
      ...CampaignSettingsFragment
    }
  }
}

Variables

{"input": UpdateCampaignSettingsInput}

Response

{
  "data": {
    "updateCampaignSettings": {
      "campaignSettings": CampaignSettings
    }
  }
}

Mutations

`updateCampaignUpdate`

Response

Returns an UpdateCampaignUpdatePayload

Arguments

Name	Description
`input` - `UpdateCampaignUpdateInput!`

Example

Query

mutation updateCampaignUpdate($input: UpdateCampaignUpdateInput!) {
  updateCampaignUpdate(input: $input) {
    ok
    id
  }
}

Variables

{"input": UpdateCampaignUpdateInput}

Response

{
  "data": {
    "updateCampaignUpdate": {
      "ok": false,
      "id": "4"
    }
  }
}

Mutations

`updateComment`

Response

Returns an UpdateCommentPayload

Arguments

Name	Description
`input` - `UpdateCommentInput!`

Example

Query

mutation updateComment($input: UpdateCommentInput!) {
  updateComment(input: $input) {
    comment {
      ...CommentFragment
    }
  }
}

Variables

{"input": UpdateCommentInput}

Response

{"data": {"updateComment": {"comment": Comment}}}

Mutations

`updateDonation`

Response

Returns an UpdateDonationPayload

Arguments

Name	Description
`input` - `UpdateDonationInput!`

Example

Query

mutation updateDonation($input: UpdateDonationInput!) {
  updateDonation(input: $input) {
    donation {
      ...DonationFragment
    }
  }
}

Variables

{"input": UpdateDonationInput}

Response

{"data": {"updateDonation": {"donation": Donation}}}

Mutations

`updateFundraiser`

Response

Returns an UpdateFundraiserPayload

Arguments

Name	Description
`input` - `UpdateFundraiserInput!`

Example

Query

mutation updateFundraiser($input: UpdateFundraiserInput!) {
  updateFundraiser(input: $input) {
    fundraiser {
      ...FundraiserFragment
    }
  }
}

Variables

{"input": UpdateFundraiserInput}

Response

{"data": {"updateFundraiser": {"fundraiser": Fundraiser}}}

Mutations

`updateLandingPage`

Response

Returns an UpdateLandingPagePayload

Arguments

Name	Description
`input` - `UpdateLandingPageInput!`

Example

Query

mutation updateLandingPage($input: UpdateLandingPageInput!) {
  updateLandingPage(input: $input) {
    landingPage {
      ...LandingPageFragment
    }
  }
}

Variables

{"input": UpdateLandingPageInput}

Response

{
  "data": {
    "updateLandingPage": {"landingPage": LandingPage}
  }
}

Mutations

`updateMovement`

Response

Returns an UpdateMovementPayload

Arguments

Name	Description
`input` - `UpdateMovementInput!`

Example

Query

mutation updateMovement($input: UpdateMovementInput!) {
  updateMovement(input: $input) {
    movement {
      ...MovementFragment
    }
  }
}

Variables

{"input": UpdateMovementInput}

Response

{"data": {"updateMovement": {"movement": Movement}}}

Mutations

`updateRegularGiving`

Response

Returns an UpdateRegularGivingPayload

Arguments

Name	Description
`input` - `UpdateRegularGivingInput!`

Example

Query

mutation updateRegularGiving($input: UpdateRegularGivingInput!) {
  updateRegularGiving(input: $input) {
    regularGiving {
      ...RegularGivingFragment
    }
  }
}

Variables

{"input": UpdateRegularGivingInput}

Response

{
  "data": {
    "updateRegularGiving": {
      "regularGiving": RegularGiving
    }
  }
}

Mutations

`updateRegularGivingPaymentMethod`

Response

Returns an UpdateRegularGivingPaymentMethodPayload

Arguments

Name	Description
`input` - `UpdateRegularGivingPaymentMethodInput!`

Example

Query

mutation updateRegularGivingPaymentMethod($input: UpdateRegularGivingPaymentMethodInput!) {
  updateRegularGivingPaymentMethod(input: $input) {
    status
    statusUri
  }
}

Variables

{"input": UpdateRegularGivingPaymentMethodInput}

Response

{
  "data": {
    "updateRegularGivingPaymentMethod": {
      "status": "Success",
      "statusUri": "abc123"
    }
  }
}

Mutations

`updateTranslation`

Response

Returns an UpdateTranslationPayload

Arguments

Name	Description
`input` - `UpdateTranslationInput!`

Example

Query

mutation updateTranslation($input: UpdateTranslationInput!) {
  updateTranslation(input: $input) {
    translation {
      ...TranslationFragment
    }
  }
}

Variables

{"input": UpdateTranslationInput}

Response

{
  "data": {
    "updateTranslation": {"translation": Translation}
  }
}

Mutations

`updateUser`

Response

Returns an UpdateUserPayload

Arguments

Name	Description
`input` - `UpdateUserInput!`

Example

Query

mutation updateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    user {
      ...UserFragment
    }
  }
}

Variables

{"input": UpdateUserInput}

Response

{"data": {"updateUser": {"user": User}}}

Types

AcquisitionSource

Fields

Field Name	Description
`label` - `String!`

Example

{"label": "abc123"}

Types

Address

Fields

Field Name	Description
`street` - `String`
`locality` - `String`
`postcode` - `String`
`region` - `String`
`country` - `Country`

Example

{
  "street": "xyz789",
  "locality": "abc123",
  "postcode": "xyz789",
  "region": "xyz789",
  "country": Country
}

Types

Amplify

Fields

Field Name	Description
`id` - `ID!`
`status` - `AmplifyStatus!`
`campaign` - `Campaign!`
`adverts` - `[AmplifyVendorCampaign!]!`

Example

{
  "id": "4",
  "status": AmplifyStatus,
  "campaign": Campaign,
  "adverts": [AmplifyVendorCampaign]
}

Types

AmplifyStatus

Fields

Field Name	Description
`id` - `ID!`
`label` - `String!`

Example

{
  "id": "4",
  "label": "xyz789"
}

Types

AmplifyStatusEnum

Values

Enum Value	Description
`Active`
`Complete`

Example

"Active"

Types

AmplifyVendor

Fields

Field Name	Description
`id` - `ID!`
`label` - `String!`

Example

{
  "id": "4",
  "label": "abc123"
}

Types

AmplifyVendorCampaign

Fields

Field Name	Description
`id` - `ID!`
`amplify` - `Amplify!`
`vendor` - `AmplifyVendor!`
`vendorReference` - `String!`

Example

{
  "id": "4",
  "amplify": Amplify,
  "vendor": AmplifyVendor,
  "vendorReference": "abc123"
}

Types

ApproveCampaignPayload

Fields

Field Name	Description
`campaign` - `Campaign!`

Example

{"campaign": Campaign}

Types

Asset

Fields

Field Name	Description
`id` - `ID!`
`url` - `URL!`
`publicUrl` - `URL!`

Example

{
  "id": "4",
  "url": "http://www.test.com/",
  "publicUrl": "http://www.test.com/"
}

Types

AssetFilterInput

Fields

Input Field	Description
`type` - `AssetType`
`isPrimary` - `Boolean`

Example

{"type": "Image", "isPrimary": false}

Types

AssetType

Values

Enum Value	Description
`Image`
`Video`

Example

"Image"

Types

AssetsOwner

Fields

Field Name	Description
`id` - `ID!`
`assets` - `[Asset!]!`
Arguments `filter` - `AssetFilterInput`

Possible Types

AssetsOwner Types
`Campaign`
`Category`
`Fundraiser`
`Perk`

Example

{"id": 4, "assets": [Asset]}

Types

AssetsOwnerType

Values

Enum Value	Description
`Campaign`
`Category`
`Fundraiser`

Example

"Campaign"

Types

AssociateAssetInput

Fields

Input Field	Description
`assetId` - `ID!`
`assetsOwnerId` - `ID!`
`assetsOwnerType` - `AssetsOwnerType!`

Example

{"assetId": 4, "assetsOwnerId": 4, "assetsOwnerType": "Campaign"}

Types

AssociateAssetPayload

Fields

Field Name	Description
`asset` - `Asset!`
`assetsOwner` - `AssetsOwner!`

Example

{
  "asset": Asset,
  "assetsOwner": AssetsOwner
}

Types

AssociateCampaignAssetInput

Fields

Input Field	Description
`assetId` - `ID!`
`campaignId` - `ID!`

Example

{"assetId": 4, "campaignId": 4}

Types

AssociateCampaignAssetPayload

Fields

Field Name	Description
`asset` - `Asset!`
`campaign` - `Campaign!`

Example

{
  "asset": Asset,
  "campaign": Campaign
}

Types

AssociateDonationPerkInput

Fields

Input Field	Description
`id` - `ID!`
`perkId` - `ID!`
`count` - `Int!`
`answer` - `String`

Example

{
  "id": 4,
  "perkId": 4,
  "count": 123,
  "answer": "abc123"
}

Types

AssociateDonationPerkPayload

Fields

Field Name	Description
`donation` - `Donation!`
`perk` - `Perk!`

Example

{"donation": Donation, "perk": Perk}

Types

AttachWebhookEventInput

Fields

Input Field	Description
`webhookId` - `ID!`
`webhookEventId` - `ID!`
`criteria` - `String`

Example

{
  "webhookId": "4",
  "webhookEventId": 4,
  "criteria": "xyz789"
}

Types

AttachWebhookEventPayload

Fields

Field Name	Description
`webhook` - `Webhook!`

Example

{"webhook": Webhook}

Types

Attempt

Fields

Field Name	Description
`id` - `ID!`
`isSuccessful` - `Boolean`
`createdAt` - `Date!`
`updatedAt` - `Date!`
`exception` - `Object`
`exceptionType` - `AttemptFailureType`

Example

{
  "id": 4,
  "isSuccessful": true,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "exception": Object,
  "exceptionType": "Hard"
}

Types

AttemptFailureType

Values

Enum Value	Description
`Hard`
`Soft`

Example

"Hard"

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

CRMAction

Fields

Field Name	Description
`id` - `ID!`
`description` - `String!`
`arguments` - `[CRMActionArgument!]!`

Example

{
  "id": "4",
  "description": "abc123",
  "arguments": [CRMActionArgument]
}

Types

CRMActionArgument

Fields

Field Name	Description
`id` - `ID!`
`label` - `String!`
`description` - `String`
`fieldType` - `CRMActionFieldType!`
`items` - `[String!]!`

Example

{
  "id": "4",
  "label": "abc123",
  "description": "xyz789",
  "fieldType": "Id",
  "items": ["xyz789"]
}

Types

CRMActionFieldType

Values

Enum Value	Description
`Id`
`String`
`List`
`Email`
`Textarea`

Example

"Id"

Types

CRMActionStatus

Values

Enum Value	Description
`Success`
`Failure`

Example

"Success"

Types

Campaign

Fields

Field Name	Description
`id` - `ID!`
`title` - `String!`
`status` - `CampaignStatus!`
`financialInformation` - `FinancialInformation!`
`slug` - `String!`
`target` - `MoneyNode!`
`collected` - `MoneyNode!`
Arguments `filter` - `DonationFilterInput`
`content` - `Markup!`
`url` - `URL!`
Arguments `shareContext` - `CampaignUrlContextInput`
`owner` - `User!`
`ownerName` - `String!`
`teams` - `[Team!]!`
`fundraisers` - `FundraiserConnection!`
Arguments `filter` - `FundraiserFilterInput` `first` - `Int` `after` - `ID`
`donations` - `DonationConnection!`
Arguments `filter` - `DonationFilterInput` `first` - `Int` `after` - `ID` `sort` - `[DonationSortableInput!]`
`regularGivings` - `RegularGivingConnection!`
Arguments `filter` - `RegularGivingFilterInput` `first` - `Int` `after` - `ID`
`assets` - `[Asset!]!`
Arguments `filter` - `AssetFilterInput`
`perks` - `[Perk!]!`
`amplify` - `Amplify`
`donationForm` - `DonationForm!`
`matchedGivings` - `[MatchedGiving!]!`
Arguments `filter` - `MatchedGivingFilterInput`
`giftAid` - `GiftAid!`
`trackingCodes` - `[CampaignTrackingCode!]!`
`comments` - `CommentConnection!`
Arguments `first` - `Int` `after` - `ID`
`createdAt` - `Date!`
`settings` - `CampaignSettings!`
`tax` - `CampaignTax`
`campCategory` - `String`
`utm` - `UTMTags`
`acquisitionSource` - `AcquisitionSource`
`duration` - `CampaignDuration!`
`address` - `Address!`
`teamMembers` - `[TeamMember!]!`
`userImage` - `String`
`integrations` - `[CampaignIntegration!]!`
Arguments `filter` - `CampaignIntegrationFilterInput`
`amplifyStatus` - `CampaignAmplifyStatus`

Example

{
  "id": "4",
  "title": "xyz789",
  "status": "Live",
  "financialInformation": FinancialInformation,
  "slug": "abc123",
  "target": MoneyNode,
  "collected": MoneyNode,
  "content": Markup,
  "url": "http://www.test.com/",
  "owner": User,
  "ownerName": "abc123",
  "teams": [Team],
  "fundraisers": FundraiserConnection,
  "donations": DonationConnection,
  "regularGivings": RegularGivingConnection,
  "assets": [Asset],
  "perks": [Perk],
  "amplify": Amplify,
  "donationForm": DonationForm,
  "matchedGivings": [MatchedGiving],
  "giftAid": GiftAid,
  "trackingCodes": [CampaignTrackingCode],
  "comments": CommentConnection,
  "createdAt": "2007-12-03",
  "settings": CampaignSettings,
  "tax": CampaignTax,
  "campCategory": "xyz789",
  "utm": UTMTags,
  "acquisitionSource": AcquisitionSource,
  "duration": CampaignDuration,
  "address": Address,
  "teamMembers": [TeamMember],
  "userImage": "abc123",
  "integrations": [CampaignIntegration],
  "amplifyStatus": CampaignAmplifyStatus
}

Types

CampaignAmplifyReceipt

Fields

Field Name	Description
`id` - `ID!`
`campaign` - `Campaign!`
`dateRange` - `String!`
`invoiceUrl` - `String!`
`createdAt` - `Date!`

Example

{
  "id": 4,
  "campaign": Campaign,
  "dateRange": "abc123",
  "invoiceUrl": "abc123",
  "createdAt": "2007-12-03"
}

Types

CampaignAmplifyReceiptConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[CampaignAmplifyReceiptEdge!]!`

Example

{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [CampaignAmplifyReceiptEdge]
}

Types

CampaignAmplifyReceiptEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `CampaignAmplifyReceipt!`

Example

{
  "cursor": "xyz789",
  "node": CampaignAmplifyReceipt
}

Types

CampaignAmplifyReceiptPayload

Fields

Field Name	Description
`receipt` - `CampaignAmplifyReceipt`

Example

{"receipt": CampaignAmplifyReceipt}

Types

CampaignAmplifyStatus

Fields

Field Name	Description
`key` - `String`
`label` - `String`

Example

{
  "key": "abc123",
  "label": "xyz789"
}

Types

CampaignConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[CampaignEdge!]!`

Example

{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [CampaignEdge]
}

Types

CampaignDuration

Fields

Field Name	Description
`startAt` - `Date!`
`finishAt` - `Date!`
`isInfinityMode` - `Boolean!`

Example

{
  "startAt": "2007-12-03",
  "finishAt": "2007-12-03",
  "isInfinityMode": false
}

Types

CampaignEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `Campaign!`

Example

{
  "cursor": "xyz789",
  "node": Campaign
}

Types

CampaignFilterInput

Fields

Input Field	Description
`query` - `String`
`email` - `Email`
`status` - `CampaignStatus`
`category` - `ID`
`amplifyStatus` - `AmplifyStatusEnum`

Example

{
  "query": "xyz789",
  "email": Email,
  "status": "Live",
  "category": 4,
  "amplifyStatus": "Active"
}

Types

CampaignIntegration

Fields

Field Name	Description
`type` - `IntegrationType!`
`reference` - `String`
`isEnabled` - `Boolean!`
`isConnected` - `Boolean!`
`createdAt` - `Date!`
`updatedAt` - `Date!`
`syncs` - `IntegrationSyncConnection!`

Example

{
  "type": "ACTION_NETWORK",
  "reference": "abc123",
  "isEnabled": false,
  "isConnected": true,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "syncs": IntegrationSyncConnection
}

Types

CampaignIntegrationFilterInput

Fields

Input Field	Description
`type` - `IntegrationType`

Example

{"type": "ACTION_NETWORK"}

Types

CampaignSettings

Fields

Field Name	Description
`isCommentsEnabled` - `Boolean!`
`isCustomDonationFormEnabled` - `Boolean!`

Example

{"isCommentsEnabled": true, "isCustomDonationFormEnabled": false}

Types

CampaignShareUrlSource

Values

Enum Value	Description
`Campaign`
`Fundraiser`
`Success`

Example

"Campaign"

Types

CampaignStatus

Values

Enum Value	Description
`Live`
`PendingApproval`
`Completed`
`Infinity`
`Denied`
`Approved`
`Draft`
`Archived`
`Redacted`

Example

"Live"

Types

CampaignTax

Fields

Field Name	Description
`reference` - `String`
`address` - `String`
`signature` - `URL`

Example

{
  "reference": "abc123",
  "address": "abc123",
  "signature": "http://www.test.com/"
}

Types

CampaignTrackingCode

Fields

Field Name	Description
`code` - `String!`
`url` - `URL!`
`adverts` - `[AmplifyVendorCampaign!]!`

Example

{
  "code": "abc123",
  "url": "http://www.test.com/",
  "adverts": [AmplifyVendorCampaign]
}

Types

CampaignUpdate

Fields

Field Name	Description
`id` - `ID!`
`title` - `String!`
`content` - `String!`
`createdAt` - `Date!`
`updateType` - `CampaignUpdateType!`
`assets` - `[CampaignUpdateAsset]`

Example

{
  "id": 4,
  "title": "xyz789",
  "content": "abc123",
  "createdAt": "2007-12-03",
  "updateType": "Text",
  "assets": [CampaignUpdateAsset]
}

Types

CampaignUpdateAsset

Fields

Field Name	Description
`id` - `ID`
`filename` - `String!`
`publicUrl` - `URL!`
`url` - `URL!`
`size` - `Int`
`fileType` - `String`

Example

{
  "id": 4,
  "filename": "xyz789",
  "publicUrl": "http://www.test.com/",
  "url": "http://www.test.com/",
  "size": 987,
  "fileType": "abc123"
}

Types

CampaignUpdateAssetInput

Fields

Input Field	Description
`filename` - `String!`
`fileType` - `String`
`size` - `Int`

Example

{
  "filename": "xyz789",
  "fileType": "xyz789",
  "size": 987
}

Types

CampaignUpdateConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[CampaignUpdateEdge!]!`

Example

{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [CampaignUpdateEdge]
}

Types

CampaignUpdateEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `CampaignUpdate!`

Example

{
  "cursor": "abc123",
  "node": CampaignUpdate
}

Types

CampaignUpdateSortable

Values

Enum Value	Description
`Recent`

Example

"Recent"

Types

CampaignUpdateSortableInput

Fields

Input Field	Description
`field` - `CampaignUpdateSortable!`
`direction` - `SortableDirection`

Example

{"field": "Recent", "direction": "Ascending"}

Types

CampaignUpdateType

Values

Enum Value	Description
`Text`
`Image`
`Video`

Example

"Text"

Types

CampaignUrlContextInput

Fields

Input Field	Description
`legacy` - `Boolean`
`socialPlatform` - `SocialPlatform`
`source` - `CampaignShareUrlSource`

Example

{"legacy": false, "socialPlatform": "Twitter", "source": "Campaign"}

Types

CancelRegularGivingPayload

Fields

Field Name	Description
`regularGiving` - `RegularGiving!`

Example

{"regularGiving": RegularGiving}

Types

CardDetailsInput

Fields

Input Field	Description
`type` - `CardType!`
`originCountry` - `CountryISOCode!`

Example

{"type": "Amex", "originCountry": CountryISOCode}

Types

CardType

Values

Enum Value	Description
`Amex`
`Visa`
`Mastercard`

Example

"Amex"

Types

ChangeCampaignBacsCapabilityPayload

Fields

Field Name	Description
`ok` - `Boolean!`
`message` - `String`

Example

{"ok": true, "message": "xyz789"}

Types

ChangeDonationRecipientInput

Fields

Input Field	Description
`id` - `ID!`
`recipientType` - `DonationRecipient!`
`recipientId` - `ID!`

Example

{
  "id": 4,
  "recipientType": "Campaign",
  "recipientId": "4"
}

Types

ChangeDonationRecipientPayload

Fields

Field Name	Description
`donation` - `Donation!`

Example

{"donation": Donation}

Types

ChangeRegularGivingRecipientInput

Fields

Input Field	Description
`id` - `ID!`
`recipientType` - `DonationRecipient!`
`recipientId` - `ID!`

Example

{
  "id": "4",
  "recipientType": "Campaign",
  "recipientId": "4"
}

Types

ChangeRegularGivingRecipientPayload

Fields

Field Name	Description
`regularGiving` - `RegularGiving!`

Example

{"regularGiving": RegularGiving}

Types

ChangeUserBacsCapabilityPayload

Fields

Field Name	Description
`ok` - `Boolean!`
`bacsAutoEnabled` - `Boolean!`
`campaignErrors` - `[String]!`
`successfulCampaigns` - `[ID]!`

Example

{
  "ok": true,
  "bacsAutoEnabled": false,
  "campaignErrors": ["xyz789"],
  "successfulCampaigns": ["4"]
}

Types

ClaimedPerk

Fields

Field Name	Description
`perk` - `Perk!`
`count` - `Int!`
`answer` - `String`

Example

{
  "perk": Perk,
  "count": 987,
  "answer": "abc123"
}

Types

Color

Example

Color

Types

Comment

Fields

Field Name	Description
`id` - `ID!`
`parent` - `Comment`
`user` - `User!`
`content` - `Markup!`
`status` - `CommentStatus!`

Example

{
  "id": 4,
  "parent": Comment,
  "user": User,
  "content": Markup,
  "status": "Published"
}

Types

CommentConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[CommentEdge!]!`

Example

{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [CommentEdge]
}

Types

CommentEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `Comment!`

Example

{
  "cursor": "xyz789",
  "node": Comment
}

Types

CommentStatus

Values

Enum Value	Description
`Published`
`Unpublished`

Example

"Published"

Types

CompleteSurveyInput

Fields

Input Field	Description
`id` - `ID!`
`netPromoterScore` - `Int!`
`bestExperience` - `String`
`worstExperience` - `String`

Example

{
  "id": 4,
  "netPromoterScore": 123,
  "bestExperience": "abc123",
  "worstExperience": "abc123"
}

Types

CompleteSurveyPayload

Fields

Field Name	Description
`survey` - `Survey!`

Example

{"survey": Survey}

Types

ConfirmVerificationCodeInput

Fields

Input Field	Description
`key` - `String!`
`code` - `String!`

Example

{
  "key": "xyz789",
  "code": "abc123"
}

Types

ConfirmVerificationCodePayload

Fields

Field Name	Description
`verified` - `Boolean!`

Example

{"verified": true}

Types

Connection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[Edge!]!`

Possible Types

Connection Types
`CampaignAmplifyReceiptConnection`
`CampaignConnection`
`CampaignUpdateConnection`
`CommentConnection`
`DisputeConnection`
`DonationConnection`
`FundraiserConnection`
`InstalmentConnection`
`IntegrationSyncConnection`
`LandingPageConnection`
`MovementConnection`
`RegularGivingConnection`
`UserConnection`

Example

{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [Edge]
}

Types

Country

Fields

Field Name	Description
`id` - `CountryISOCode!`
`name` - `String!`
`currency` - `Currency!`

Example

{
  "id": CountryISOCode,
  "name": "xyz789",
  "currency": Currency
}

Types

CountryFilterInput

Fields

Input Field	Description
`campaignSupported` - `Boolean`

Example

{"campaignSupported": false}

Types

CountryISOCode

Example

CountryISOCode

Types

CreateAmplifyVendorCampaignInput

Fields

Input Field	Description
`campaignId` - `ID!`
`vendorId` - `ID!`
`vendorReference` - `String!`
`vendorState` - `Object`

Example

{
  "campaignId": "4",
  "vendorId": "4",
  "vendorReference": "xyz789",
  "vendorState": Object
}

Types

CreateAmplifyVendorCampaignPayload

Fields

Field Name	Description
`advert` - `AmplifyVendorCampaign!`

Example

{"advert": AmplifyVendorCampaign}

Types

CreateAssetInput

Fields

Input Field	Description
`asset` - `Upload!`

Example

{"asset": Upload}

Types

CreateAssetPayload

Fields

Field Name	Description
`asset` - `Asset!`

Example

{"asset": Asset}

Types

CreateCampaignAmplifyReceiptInput

Fields

Input Field	Description
`campaignId` - `ID!`
`endDate` - `String`
`generateEmail` - `Boolean`

Example

{
  "campaignId": 4,
  "endDate": "abc123",
  "generateEmail": false
}

Types

CreateCampaignInput

Fields

Input Field	Description
`title` - `String!`
`userId` - `ID`
`target` - `Money!`
`country` - `CountryISOCode!`
`categoryId` - `ID!`
`content` - `Markup!`
`tracking` - `PageTrackingInput`
`meta` - `[MetaValueInput!]`

Example

{
  "title": "abc123",
  "userId": "4",
  "target": Money,
  "country": CountryISOCode,
  "categoryId": 4,
  "content": Markup,
  "tracking": PageTrackingInput,
  "meta": [MetaValueInput]
}

Types

CreateCampaignPayload

Fields

Field Name	Description
`campaign` - `Campaign!`

Example

{"campaign": Campaign}

Types

CreateCampaignTrackingCodeInput

Fields

Input Field	Description
`id` - `ID!`
`code` - `String`

Example

{"id": 4, "code": "abc123"}

Types

CreateCampaignTrackingCodePayload

Fields

Field Name	Description
`trackingCode` - `CampaignTrackingCode!`

Example

{"trackingCode": CampaignTrackingCode}

Types

CreateCampaignUpdateInput

Fields

Input Field	Description
`campaignId` - `ID!`
`title` - `String!`
`content` - `String!`
`updateType` - `CampaignUpdateType!`
`assets` - `[CampaignUpdateAssetInput]`
`sendViaEmail` - `Boolean!`

Example

{
  "campaignId": "4",
  "title": "xyz789",
  "content": "xyz789",
  "updateType": "Text",
  "assets": [CampaignUpdateAssetInput],
  "sendViaEmail": false
}

Types

CreateCampaignUpdatePayload

Fields

Field Name	Description
`ok` - `Boolean!`
`campaignId` - `ID!`

Example

{"ok": true, "campaignId": "4"}

Types

CreateDirectDebitPayload

Fields

Field Name	Description
`session` - `String!`
`customer` - `String!`

Example

{
  "session": "xyz789",
  "customer": "abc123"
}

Types

CreateDirectDebitRegularGivingInput

Fields

Input Field	Description
`id` - `ID!`
`url` - `URL!`

Example

{
  "id": "4",
  "url": "http://www.test.com/"
}

Types

CreateDirectDebitRegularGivingPayload

Fields

Field Name	Description
`session` - `String!`
`customer` - `String!`

Example

{
  "session": "xyz789",
  "customer": "xyz789"
}

Types

CreateFundraiserInput

Fields

Input Field	Description
`campaignId` - `ID!`
`fundraiserName` - `String!`

Example

{
  "campaignId": 4,
  "fundraiserName": "xyz789"
}

Types

CreateFundraiserPayload

Fields

Field Name	Description
`fundraiser` - `Fundraiser!`

Example

{"fundraiser": Fundraiser}

Types

CreateLandingPageInput

Fields

Input Field	Description
`title` - `String!`
`description` - `String!`
`slug` - `String!`
`image` - `URL!`
`category` - `String!`
`countries` - `String!`
`styles` - `String`

Example

{
  "title": "xyz789",
  "description": "xyz789",
  "slug": "abc123",
  "image": "http://www.test.com/",
  "category": "xyz789",
  "countries": "abc123",
  "styles": "abc123"
}

Types

CreateLandingPagePayload

Fields

Field Name	Description
`landingPage` - `LandingPage!`

Example

{"landingPage": LandingPage}

Types

CreateMovementInput

Fields

Input Field	Description
`title` - `String!`
`slug` - `String`
`heading` - `String!`
`description` - `String!`
`image` - `Upload`

Example

{
  "title": "xyz789",
  "slug": "xyz789",
  "heading": "xyz789",
  "description": "abc123",
  "image": Upload
}

Types

CreateMovementPayload

Fields

Field Name	Description
`movement` - `Movement!`

Example

{"movement": Movement}

Types

CreateOfflineDonationInput

Fields

Input Field	Description
`campaignId` - `ID!`
`fundraiserId` - `ID`
`perkId` - `ID`
`name` - `String!`
`amount` - `Money!`

Example

{
  "campaignId": "4",
  "fundraiserId": 4,
  "perkId": 4,
  "name": "xyz789",
  "amount": Money
}

Types

CreateOfflineDonationPayload

Fields

Field Name	Description
`donation` - `Donation!`

Example

{"donation": Donation}

Types

CreateSetupIntentRegularGivingPayload

Fields

Field Name	Description
`regularGiving` - `RegularGiving!`
`token` - `ID!`

Example

{
  "regularGiving": RegularGiving,
  "token": "4"
}

Types

CreateTeamInput

Fields

Input Field	Description
`campaignId` - `ID!`
`title` - `String!`
`target` - `Money!`
`logo` - `URL!`

Example

{
  "campaignId": 4,
  "title": "xyz789",
  "target": Money,
  "logo": "http://www.test.com/"
}

Types

CreateTeamPayload

Fields

Field Name	Description
`team` - `Team!`

Example

{"team": Team}

Types

CreateTranslationKeysPayload

Fields

Field Name	Description
`keys` - `[TranslationKey!]!`

Example

{"keys": [TranslationKey]}

Types

CreateTranslationLanguagePayload

Fields

Field Name	Description
`language` - `Language!`

Example

{"language": Language}

Types

CreateVerificationCodeInput

Fields

Input Field	Description
`email` - `String!`

Example

{"email": "xyz789"}

Types

CreateVerificationCodePayload

Fields

Field Name	Description
`key` - `String!`
`nextCodeAt` - `String!`

Example

{
  "key": "abc123",
  "nextCodeAt": "abc123"
}

Types

CreateWebhookInput

Fields

Input Field	Description
`url` - `URL!`
`description` - `String!`
`secret` - `String!`

Example

{
  "url": "http://www.test.com/",
  "description": "xyz789",
  "secret": "xyz789"
}

Types

CreateWebhookPayload

Fields

Field Name	Description
`webhook` - `Webhook!`

Example

{"webhook": Webhook}

Types

Currency

Fields

Field Name	Description
`key` - `CurrencyISOCode!`
`name` - `String!`
`symbol` - `String!`
`fractional` - `String!`
`conversions` - `[CurrencyConversion!]!`

Example

{
  "key": CurrencyISOCode,
  "name": "abc123",
  "symbol": "abc123",
  "fractional": "abc123",
  "conversions": [CurrencyConversion]
}

Types

CurrencyConversion

Fields

Field Name	Description
`key` - `CurrencyISOCode!`
`value` - `Float!`

Example

{"key": CurrencyISOCode, "value": 987.65}

Types

CurrencyISOCode

Example

CurrencyISOCode

Types

Date

Example

"2007-12-03"

Types

DeleteAssetPayload

Fields

Field Name	Description
`asset` - `Asset!`

Example

{"asset": Asset}

Types

DeleteCampaignPayload

Fields

Field Name	Description
`ok` - `Boolean!`

Example

{"ok": true}

Types

DeleteCampaignUpdatePayload

Fields

Field Name	Description
`ok` - `Boolean!`

Example

{"ok": false}

Types

DeleteOfflineDonationPayload

Fields

Field Name	Description
`donation` - `Donation!`

Example

{"donation": Donation}

Types

DeleteUserPayload

Fields

Field Name	Description
`ok` - `Boolean!`

Example

{"ok": false}

Types

DisassociateAssetInput

Fields

Input Field	Description
`assetId` - `ID!`
`assetsOwnerId` - `ID!`
`assetsOwnerType` - `AssetsOwnerType!`

Example

{
  "assetId": "4",
  "assetsOwnerId": "4",
  "assetsOwnerType": "Campaign"
}

Types

DisassociateAssetPayload

Fields

Field Name	Description
`asset` - `Asset!`
`assetsOwner` - `AssetsOwner!`

Example

{
  "asset": Asset,
  "assetsOwner": AssetsOwner
}

Types

DisassociateCampaignAssetInput

Fields

Input Field	Description
`assetId` - `ID!`
`campaignId` - `ID!`

Example

{"assetId": 4, "campaignId": 4}

Types

DisassociateCampaignAssetPayload

Fields

Field Name	Description
`asset` - `Asset!`
`campaign` - `Campaign!`

Example

{
  "asset": Asset,
  "campaign": Campaign
}

Types

DisassociateDonationPerkPayload

Fields

Field Name	Description
`donation` - `Donation!`
`perk` - `Perk!`

Example

{"donation": Donation, "perk": Perk}

Types

DispatchCampaignAmplifyReceiptsInput

Fields

Input Field	Description
`generateEmails` - `Boolean`

Example

{"generateEmails": true}

Types

DispatchCampaignAmplifyReceiptsPayload

Fields

Field Name	Description
`receipts` - `[CampaignAmplifyReceipt]`

Example

{"receipts": [CampaignAmplifyReceipt]}

Types

DispatchEvent

Values

Enum Value	Description
`OnboardingStarted`

Example

"OnboardingStarted"

Types

DispatchEventInput

Fields

Input Field	Description
`event` - `DispatchEvent!`
`identity` - `EventIdentityInput`
`payload` - `Object!`

Example

{
  "event": "OnboardingStarted",
  "identity": EventIdentityInput,
  "payload": Object
}

Types

DispatchEventPayload

Fields

Field Name	Description
`ok` - `Boolean!`

Example

{"ok": false}

Types

Dispute

Fields

Field Name	Description
`id` - `ID!`
`status` - `DisputeStatus!`
`amount` - `Money!`
`reason` - `String!`
`user` - `User!`
`donation` - `Donation!`
`createdAt` - `Date!`
`updatedAt` - `Date!`

Example

{
  "id": "4",
  "status": "Unanswered",
  "amount": Money,
  "reason": "abc123",
  "user": User,
  "donation": Donation,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

DisputeConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[DisputeEdge!]!`

Example

{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [DisputeEdge]
}

Types

DisputeEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `Dispute!`

Example

{
  "cursor": "abc123",
  "node": Dispute
}

Types

DisputeStatus

Values

Enum Value	Description
`Unanswered`
`UnderReview`
`Error`
`Lost`
`Won`

Example

"Unanswered"

Types

Donation

Fields

Field Name	Description
`id` - `ID!`
`hashId` - `ID!`
`user` - `User`
`amount` - `MoneyNode!`
`name` - `String!`
`createdAt` - `Date!`
`source` - `DonationSource!`
`status` - `DonationStatus!`
`visibility` - `DonationVisibility!`
`receipt` - `Asset`
`campaign` - `Campaign!`
`fundraiser` - `Fundraiser`
`perk` - `ClaimedPerk`
`paymentMethod` - `UserPaymentMethod`
`regularGiving` - `RegularGiving`
`tracking` - `CampaignTrackingCode`
`utm` - `UTMTags`
`ipAddress` - `IPAddress`
`isRefunded` - `Boolean!`
`giftAid` - `GiftAid`

Example

{
  "id": 4,
  "hashId": "4",
  "user": User,
  "amount": MoneyNode,
  "name": "abc123",
  "createdAt": "2007-12-03",
  "source": "Online",
  "status": "Confirmed",
  "visibility": "Anonymous",
  "receipt": Asset,
  "campaign": Campaign,
  "fundraiser": Fundraiser,
  "perk": ClaimedPerk,
  "paymentMethod": UserPaymentMethod,
  "regularGiving": RegularGiving,
  "tracking": CampaignTrackingCode,
  "utm": UTMTags,
  "ipAddress": IPAddress,
  "isRefunded": false,
  "giftAid": GiftAid
}

Types

DonationConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[DonationEdge!]!`

Example

{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [DonationEdge]
}

Types

DonationEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `Donation!`

Example

{
  "cursor": "xyz789",
  "node": Donation
}

Types

DonationFee

Fields

Field Name	Description
`fee` - `MoneyNode!`
`tip` - `MoneyNode!`
`donation` - `MoneyNode!`
`totalPaid` - `MoneyNode!`
`totalReceived` - `MoneyNode!`

Example

{
  "fee": MoneyNode,
  "tip": MoneyNode,
  "donation": MoneyNode,
  "totalPaid": MoneyNode,
  "totalReceived": MoneyNode
}

Types

DonationFeeInput

Fields

Input Field	Description
`donation` - `Money!`
`tip` - `Money`
`paymentVendor` - `PaymentMethodVendor!`
`cardDetails` - `CardDetailsInput`
`campaignId` - `ID`
`paymentModel` - `PaymentModelType`
`country` - `CountryISOCode`

Example

{
  "donation": Money,
  "tip": Money,
  "paymentVendor": "Stripe",
  "cardDetails": CardDetailsInput,
  "campaignId": "4",
  "paymentModel": "Shared",
  "country": CountryISOCode
}

Types

DonationFilterInput

Fields

Input Field	Description
`query` - `String`
`confirmed` - `DonationStatus`
`visibility` - `DonationVisibility`
`source` - `DonationSource`
`recipient` - `DonationRecipientFilter`
`paymentVendor` - `PaymentMethodVendor`
`paymentType` - `PaymentMethodType`
`isAmplified` - `Boolean`
`isRegularGiving` - `Boolean`

Example

{
  "query": "xyz789",
  "confirmed": "Confirmed",
  "visibility": "Anonymous",
  "source": "Online",
  "recipient": "Campaign",
  "paymentVendor": "Stripe",
  "paymentType": "Card",
  "isAmplified": true,
  "isRegularGiving": true
}

Types

DonationForm

Fields

Field Name	Description
`fields` - `[DonationFormField!]!`
`levels` - `[DonationFormLevel!]!`
`defaultValueAmounts` - `[Int!]!`
`template` - `DonationFormTemplate`
`defaultPaymentMethod` - `PaymentFrequency!`
`frequency` - `DonationFormFrequency!`
`requiresOptInMarketing` - `Boolean!`
`mode` - `DonationFormMode!`

Example

{
  "fields": [DonationFormField],
  "levels": [DonationFormLevel],
  "defaultValueAmounts": [123],
  "template": DonationFormTemplate,
  "defaultPaymentMethod": "OneOff",
  "frequency": DonationFormFrequency,
  "requiresOptInMarketing": true,
  "mode": "None"
}

Types

DonationFormField

Fields

Field Name	Description
`id` - `ID!`
`isCustom` - `Boolean!`
`type` - `FormType!`
`label` - `String!`
`options` - `[String!]!`
`status` - `FieldStatus!`

Example

{
  "id": "4",
  "isCustom": false,
  "type": "Select",
  "label": "xyz789",
  "options": ["xyz789"],
  "status": "Required"
}

Types

DonationFormFrequency

Fields

Field Name	Description
`isEnabled` - `Boolean!`
`allowMonthly` - `Boolean!`
`allowWeekly` - `Boolean!`
`allowYearly` - `Boolean!`

Example

{
  "isEnabled": false,
  "allowMonthly": false,
  "allowWeekly": false,
  "allowYearly": true
}

Types

DonationFormLevel

Fields

Field Name	Description
`label` - `String!`
`value` - `MoneyNode!`

Example

{
  "label": "xyz789",
  "value": MoneyNode
}

Types

DonationFormMode

Values

Enum Value	Description
`None`
`Perk`
`ImpactLevel`

Example

"None"

Types

DonationFormTemplate

Example

DonationFormTemplate

Types

DonationRecipient

Values

Enum Value	Description
`Campaign`
`Fundraiser`

Example

"Campaign"

Types

DonationRecipientFilter

Values

Enum Value	Description
`Campaign`
`Fundraiser`
`All`

Example

"Campaign"

Types

DonationRefundType

Values

Enum Value	Description
`Full`
`Optional`

Example

"Full"

Types

DonationSortable

Values

Enum Value	Description
`Recent`

Example

"Recent"

Types

DonationSortableInput

Fields

Input Field	Description
`field` - `DonationSortable!`
`direction` - `SortableDirection`

Example

{"field": "Recent", "direction": "Ascending"}

Types

DonationSource

Values

Enum Value	Description
`Online`
`Offline`

Example

"Online"

Types

DonationStatus

Values

Enum Value	Description
`Confirmed`
`Unconfirmed`

Example

"Confirmed"

Types

DonationVisibility

Values

Enum Value	Description
`Anonymous`
`Public`

Example

"Anonymous"

Types

Edge

Fields

Field Name	Description
`node` - `Node!`
`cursor` - `String!`

Possible Types

Edge Types
`CampaignAmplifyReceiptEdge`
`CampaignEdge`
`CampaignUpdateEdge`
`CommentEdge`
`DisputeEdge`
`DonationEdge`
`FundraiserEdge`
`InstalmentEdge`
`IntegrationSyncEdge`
`LandingPageEdge`
`MovementEdge`
`RegularGivingEdge`
`UserEdge`

Example

{
  "node": Node,
  "cursor": "xyz789"
}

Types

Email

Example

Email

Types

EventIdentityInput

Fields

Input Field	Description
`email` - `Email!`

Example

{"email": Email}

Types

ExecuteCRMActionInput

Fields

Input Field	Description
`id` - `ID!`
`arguments` - `Object!`

Example

{"id": 4, "arguments": Object}

Types

ExecuteCRMActionPayload

Fields

Field Name	Description
`message` - `String!`
`status` - `CRMActionStatus!`
`context` - `Object!`

Example

{
  "message": "xyz789",
  "status": "Success",
  "context": Object
}

Types

FeeStructure

Fields

Field Name	Description
`country` - `Country!`
`currency` - `Currency!`
`state` - `Object!`

Example

{
  "country": Country,
  "currency": Currency,
  "state": Object
}

Types

FieldStatus

Values

Enum Value	Description
`Required`
`Locked`
`Enabled`
`Disabled`

Example

"Required"

Types

FinancialInformation

Fields

Field Name	Description
`currency` - `Currency!`
`paymentMethods` - `[FinancialInformationPaymentMethod!]!`
Arguments `available` - `Boolean`
`feeStructure` - `FeeStructure`
`paymentModel` - `PaymentModel!`

Example

{
  "currency": Currency,
  "paymentMethods": [FinancialInformationPaymentMethod],
  "feeStructure": FeeStructure,
  "paymentModel": PaymentModel
}

Types

FinancialInformationPaymentMethod

Fields

Field Name	Description
`paymentMethod` - `PaymentMethod!`
`key` - `String!`

Example

{
  "paymentMethod": PaymentMethod,
  "key": "xyz789"
}

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

FormType

Values

Enum Value	Description
`Select`
`Text`
`Checkbox`

Example

"Select"

Types

Fundraiser

Fields

Field Name	Description
`id` - `ID!`
`campaign` - `Campaign!`
`status` - `FundraiserStatus!`
`team` - `Team`
`owner` - `User!`
`title` - `String!`	use fundraiserName instead
`content` - `Markup!`
`slug` - `String!`
`target` - `MoneyNode!`
`collected` - `MoneyNode!`
`video` - `URL`
`url` - `URL!`
`donations` - `DonationConnection!`
Arguments `filter` - `DonationFilterInput` `first` - `Int` `after` - `ID` `sort` - `[DonationSortableInput!]`
`assets` - `[Asset!]!`
Arguments `filter` - `AssetFilterInput`
`fundraiserName` - `String!`
`fundraiserEmail` - `Email!`
`fundraiserProfile` - `URL`

Example

{
  "id": "4",
  "campaign": Campaign,
  "status": "Draft",
  "team": Team,
  "owner": User,
  "title": "xyz789",
  "content": Markup,
  "slug": "abc123",
  "target": MoneyNode,
  "collected": MoneyNode,
  "video": "http://www.test.com/",
  "url": "http://www.test.com/",
  "donations": DonationConnection,
  "assets": [Asset],
  "fundraiserName": "abc123",
  "fundraiserEmail": Email,
  "fundraiserProfile": "http://www.test.com/"
}

Types

FundraiserConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[FundraiserEdge!]!`

Example

{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [FundraiserEdge]
}

Types

FundraiserEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `Fundraiser!`

Example

{
  "cursor": "abc123",
  "node": Fundraiser
}

Types

FundraiserFilterInput

Fields

Input Field	Description
`isActive` - `Boolean`

Example

{"isActive": true}

Types

FundraiserStatus

Values

Enum Value	Description
`Draft`
`Live`
`Completed`
`Deleted`

Example

"Draft"

Types

GiftAid

Fields

Field Name	Description
`isEnabled` - `Boolean!`
`officialName` - `String!`

Example

{
  "isEnabled": true,
  "officialName": "xyz789"
}

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

Types

IPAddress

Example

IPAddress

Types

ImportTranslationInput

Fields

Input Field	Description
`languageId` - `ID!`
`url` - `URL!`

Example

{
  "languageId": "4",
  "url": "http://www.test.com/"
}

Types

ImportTranslationPayload

Fields

Field Name	Description
`accepted` - `Boolean!`

Example

{"accepted": false}

Types

Instalment

Fields

Field Name	Description
`id` - `ID!`
`createdAt` - `Date!`
`instalmentAt` - `Date!`
`attempts` - `[Attempt!]!`

Example

{
  "id": 4,
  "createdAt": "2007-12-03",
  "instalmentAt": "2007-12-03",
  "attempts": [Attempt]
}

Types

InstalmentConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[InstalmentEdge!]!`

Example

{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [InstalmentEdge]
}

Types

InstalmentEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `Instalment!`

Example

{
  "cursor": "xyz789",
  "node": Instalment
}

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

IntegrationSync

Fields

Field Name	Description
`id` - `ID!`
`donation` - `Donation!`
`isSuccessful` - `Boolean!`
`exceptionMessage` - `String`

Example

{
  "id": 4,
  "donation": Donation,
  "isSuccessful": true,
  "exceptionMessage": "xyz789"
}

Types

IntegrationSyncConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[IntegrationSyncEdge!]!`

Example

{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [IntegrationSyncEdge]
}

Types

IntegrationSyncEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `IntegrationSync!`

Example

{
  "cursor": "abc123",
  "node": IntegrationSync
}

Types

IntegrationType

Values

Enum Value	Description
`ACTION_NETWORK`
`SALESFORCE`
`MAILCHIMP`
`FACEBOOK_PIXEL`
`GOOGLE_ANALYTICS`

Example

"ACTION_NETWORK"

Types

LandingPage

Fields

Field Name	Description
`id` - `ID!`
`title` - `String!`
`description` - `String!`
`image` - `URL!`
`isActive` - `Boolean!`
`theme` - `String!`
`slug` - `String!`
`countries` - `[String!]!`

Example

{
  "id": "4",
  "title": "xyz789",
  "description": "abc123",
  "image": "http://www.test.com/",
  "isActive": false,
  "theme": "xyz789",
  "slug": "abc123",
  "countries": ["xyz789"]
}

Types

LandingPageConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[LandingPageEdge!]!`

Example

{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [LandingPageEdge]
}

Types

LandingPageEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `LandingPage!`

Example

{
  "cursor": "xyz789",
  "node": LandingPage
}

Types

LandingPageFilterInput

Fields

Input Field	Description
`isActive` - `Boolean`

Example

{"isActive": false}

Types

Language

Fields

Field Name	Description
`id` - `ID!`
`csvFileUrl` - `URL`
`jsonFileUrl` - `URL`

Example

{
  "id": 4,
  "csvFileUrl": "http://www.test.com/",
  "jsonFileUrl": "http://www.test.com/"
}

Types

LaunchCampaignInput

Fields

Input Field	Description
`id` - `ID!`
`acquisitionSource` - `String`

Example

{
  "id": "4",
  "acquisitionSource": "abc123"
}

Types

LaunchCampaignPayload

Fields

Field Name	Description
`campaign` - `Campaign!`

Example

{"campaign": Campaign}

Types

LinkCampaignTrackingCodeToAmplifyCampaignInput

Fields

Input Field	Description
`campaignId` - `ID!`
`code` - `String!`
`amplifyVendorCampaignId` - `ID!`

Example

{
  "campaignId": "4",
  "code": "xyz789",
  "amplifyVendorCampaignId": "4"
}

Types

LinkCampaignTrackingCodeToAmplifyCampaignPayload

Fields

Field Name	Description
`trackingCode` - `CampaignTrackingCode!`

Example

{"trackingCode": CampaignTrackingCode}

Types

LinkFundraiserTeamInput

Fields

Input Field	Description
`fundraiserId` - `ID!`
`teamId` - `ID!`

Example

{"fundraiserId": 4, "teamId": "4"}

Types

LinkFundraiserTeamPayload

Fields

Field Name	Description
`team` - `Team!`
`fundraiser` - `Fundraiser!`

Example

{
  "team": Team,
  "fundraiser": Fundraiser
}

Types

LoginAsPayload

Fields

Field Name	Description
`ok` - `Boolean!`
`url` - `URL!`

Example

{"ok": true, "url": "http://www.test.com/"}

Types

LoginInput

Fields

Input Field	Description
`email` - `Email!`
`password` - `String!`

Example

{
  "email": Email,
  "password": "xyz789"
}

Types

LoginPayload

Fields

Field Name	Description
`user` - `User`
`bearerToken` - `String`
`intended` - `URL`

Example

{
  "user": User,
  "bearerToken": "xyz789",
  "intended": "http://www.test.com/"
}

Types

LogoutPayload

Fields

Field Name	Description
`ok` - `Boolean!`

Example

{"ok": true}

Types

Markup

Example

Markup

Types

MatchedGiving

Fields

Field Name	Description
`id` - `ID!`
`title` - `String!`
`image` - `Asset`
`target` - `MoneyNode`
`remaining` - `MoneyNode`
`hasMetTarget` - `Boolean!`
`startAt` - `Date`
`finishAt` - `Date`

Example

{
  "id": 4,
  "title": "xyz789",
  "image": Asset,
  "target": MoneyNode,
  "remaining": MoneyNode,
  "hasMetTarget": false,
  "startAt": "2007-12-03",
  "finishAt": "2007-12-03"
}

Types

MatchedGivingFilterInput

Fields

Input Field	Description
`available` - `Boolean!`

Example

{"available": false}

Types

MetaValueInput

Fields

Input Field	Description
`key` - `String!`
`value` - `String!`

Example

{
  "key": "xyz789",
  "value": "abc123"
}

Types

Money

Example

Money

Types

MoneyNode

Fields

Field Name	Description
`amount` - `String!`
`currency` - `String!`
`currencyNode` - `Currency!`

Example

{
  "amount": "abc123",
  "currency": "abc123",
  "currencyNode": Currency
}

Types

Movement

Fields

Field Name	Description
`id` - `ID!`
`title` - `String!`
`heading` - `String!`
`description` - `String!`
`slug` - `String!`

Example

{
  "id": "4",
  "title": "xyz789",
  "heading": "abc123",
  "description": "abc123",
  "slug": "xyz789"
}

Types

MovementConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[MovementEdge!]!`

Example

{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [MovementEdge]
}

Types

MovementEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `Movement!`

Example

{
  "cursor": "abc123",
  "node": Movement
}

Types

Node

Fields

Field Name	Description
`id` - `ID!`

Possible Types

Node Types
`CampaignAmplifyReceipt`
`CampaignUpdate`
`Campaign`
`Category`
`Comment`
`Dispute`
`Donation`
`Fundraiser`
`Instalment`
`IntegrationSync`
`LandingPage`
`Movement`
`Perk`
`RegularGiving`
`User`

Example

{"id": "4"}

Types

Object

Example

Object

Types

PageInfo

Fields

Field Name	Description
`hasNextPage` - `Boolean!`
`hasPreviousPage` - `Boolean!`
`startCursor` - `String`
`endCursor` - `String`

Example

{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "abc123",
  "endCursor": "abc123"
}

Types

PageTrackingInput

Fields

Input Field	Description
`page` - `URL!`
`source` - `String`
`medium` - `String`
`campaign` - `String`
`term` - `String`
`content` - `String`

Example

{
  "page": "http://www.test.com/",
  "source": "abc123",
  "medium": "abc123",
  "campaign": "abc123",
  "term": "abc123",
  "content": "abc123"
}

Types

PaymentFrequency

Values

Enum Value	Description
`OneOff`
`Recurring`

Example

"OneOff"

Types

PaymentFrequencyRecurring

Values

Enum Value	Description
`Weekly`
`Monthly`
`Yearly`

Example

"Weekly"

Types

PaymentMethod

Fields

Field Name	Description
`vendor` - `PaymentMethodVendor!`
`publishableKey` - `String`
`accountNumber` - `String`
`connectUrl` - `URL`
`availableMethods` - `[String]`

Example

{
  "vendor": "Stripe",
  "publishableKey": "xyz789",
  "accountNumber": "abc123",
  "connectUrl": "http://www.test.com/",
  "availableMethods": ["xyz789"]
}

Types

PaymentMethodType

Values

Enum Value	Description
`Card`
`DirectDebit`
`Account`

Example

"Card"

Types

PaymentMethodVendor

Values

Enum Value	Description
`Stripe`
`Paypal`

Example

"Stripe"

Types

PaymentModel

Fields

Field Name	Description
`type` - `PaymentModelType!`
`hasOptionalDonations` - `Boolean!`
`paymentFeeBelowLine` - `Boolean!`
`platformFeePercent` - `Float!`

Example

{
  "type": "Shared",
  "hasOptionalDonations": true,
  "paymentFeeBelowLine": true,
  "platformFeePercent": 987.65
}

Types

PaymentModelType

Values

Enum Value	Description
`Shared`
`FlatFee`
`Keep`

Example

"Shared"

Types

PaymentPrefillInput

Fields

Input Field	Description
`token` - `String!`
`email` - `String!`

Example

{
  "token": "abc123",
  "email": "abc123"
}

Types

Perk

Fields

Field Name	Description
`id` - `ID!`
`campaign` - `Campaign!`
`title` - `String!`
`amount` - `MoneyNode!`
`description` - `String`
`useImage` - `Boolean!`
`assets` - `[Asset!]!`
Arguments `filter` - `AssetFilterInput`
`delivery` - `String`
`questions` - `[PerkQuestion!]!`
`isQuestionEnabled` - `Boolean!`
`isPublished` - `Boolean!`	use isHidden instead
`isHidden` - `Boolean!`
`quantity` - `PerkQuantity!`
`frequency` - `PerkRedemptionFrequency!`
`allowMultiple` - `Boolean!`

Example

{
  "id": 4,
  "campaign": Campaign,
  "title": "xyz789",
  "amount": MoneyNode,
  "description": "abc123",
  "useImage": true,
  "assets": [Asset],
  "delivery": "xyz789",
  "questions": [PerkQuestion],
  "isQuestionEnabled": false,
  "isPublished": true,
  "isHidden": false,
  "quantity": PerkQuantity,
  "frequency": PerkRedemptionFrequency,
  "allowMultiple": false
}

Types

PerkQuantity

Fields

Field Name	Description
`isUnlimited` - `Boolean!`
`total` - `Int!`
`redeemed` - `Int!`
`available` - `Int!`

Example

{"isUnlimited": false, "total": 987, "redeemed": 123, "available": 987}

Types

PerkQuestion

Fields

Field Name	Description
`id` - `ID!`
`type` - `FormType!`
`label` - `String!`
`options` - `[String!]!`

Example

{
  "id": 4,
  "type": "Select",
  "label": "xyz789",
  "options": ["abc123"]
}

Types

PerkRedemptionFrequency

Fields

Field Name	Description
`allowOneOff` - `Boolean!`
`allowMonthly` - `Boolean!`
`allowWeekly` - `Boolean!`
`allowYearly` - `Boolean!`

Example

{
  "allowOneOff": false,
  "allowMonthly": false,
  "allowWeekly": true,
  "allowYearly": true
}

Types

Phone

Example

Phone

Types

ProcessPaymentStatus

Values

Enum Value	Description
`Success`
`Failure`
`Pending`

Example

"Success"

Types

Recipient

Fields

Field Name	Description
`id` - `ID!`
`url` - `URL!`
`title` - `String!`
`assets` - `[Asset!]!`
Arguments `filter` - `AssetFilterInput`

Possible Types

Recipient Types
`Campaign`
`Fundraiser`

Example

{
  "id": 4,
  "url": "http://www.test.com/",
  "title": "abc123",
  "assets": [Asset]
}

Types

RefundDonationInput

Fields

Input Field	Description
`id` - `ID!`
`type` - `DonationRefundType`

Example

{"id": "4", "type": "Full"}

Types

RefundDonationPayload

Fields

Field Name	Description
`donation` - `Donation!`

Example

{"donation": Donation}

Types

RegularGiving

Fields

Field Name	Description
`id` - `ID!`
`donations` - `DonationConnection!`
Arguments `filter` - `DonationFilterInput` `first` - `Int` `after` - `ID` `sort` - `[DonationSortableInput!]`
`frequency` - `PaymentFrequencyRecurring!`
`user` - `User!`
`campaign` - `Campaign!`
`fundraiser` - `Fundraiser`
`status` - `RegularGivingStatus!`
`nextPaymentAt` - `Date!`
`startAt` - `Date!`
`endAt` - `Date`
`amount` - `MoneyNode!`
`optionalDonation` - `MoneyNode!`
`fees` - `MoneyNode!`
`perk` - `ClaimedPerk`
`paymentMethod` - `UserPaymentMethod`
`schedules` - `[Schedule!]!`

Example

{
  "id": "4",
  "donations": DonationConnection,
  "frequency": "Weekly",
  "user": User,
  "campaign": Campaign,
  "fundraiser": Fundraiser,
  "status": "Created",
  "nextPaymentAt": "2007-12-03",
  "startAt": "2007-12-03",
  "endAt": "2007-12-03",
  "amount": MoneyNode,
  "optionalDonation": MoneyNode,
  "fees": MoneyNode,
  "perk": ClaimedPerk,
  "paymentMethod": UserPaymentMethod,
  "schedules": [Schedule]
}

Types

RegularGivingConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[RegularGivingEdge!]!`

Example

{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [RegularGivingEdge]
}

Types

RegularGivingEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `RegularGiving!`

Example

{
  "cursor": "xyz789",
  "node": RegularGiving
}

Types

RegularGivingFilterInput

Fields

Input Field	Description
`status` - `RegularGivingStatus`
`userId` - `ID`

Example

{"status": "Created", "userId": "4"}

Types

RegularGivingFrequencyDate

Fields

Field Name	Description
`frequency` - `PaymentFrequencyRecurring!`
`nextPaymentAt` - `Date!`

Example

{
  "frequency": "Weekly",
  "nextPaymentAt": "2007-12-03"
}

Types

RegularGivingStatus

Values

Enum Value	Description
`Created`
`Verified`
`Active`
`Cancelled`
`Failed`
`Paused`
`Ended`

Example

"Created"

Types

RejectCampaignInput

Fields

Input Field	Description
`id` - `ID!`
`reason` - `String`

Example

{"id": 4, "reason": "xyz789"}

Types

RejectCampaignPayload

Fields

Field Name	Description
`campaign` - `Campaign!`

Example

{"campaign": Campaign}

Types

ReportCampaignComplainantInput

Fields

Input Field	Description
`name` - `String!`
`email` - `String!`

Example

{
  "name": "abc123",
  "email": "xyz789"
}

Types

ReportCampaignDetailsInput

Fields

Input Field	Description
`complaintType` - `ReportCampaignSubjectType!`
`campaignLink` - `String!`
`campaignId` - `ID`
`complaintReason` - `[ReportCampaignReasonType]!`
`description` - `String!`

Example

{
  "complaintType": "Page",
  "campaignLink": "abc123",
  "campaignId": 4,
  "complaintReason": ["Defamatory"],
  "description": "abc123"
}

Types

ReportCampaignInput

Fields

Input Field	Description
`complainant` - `ReportCampaignComplainantInput!`
`details` - `ReportCampaignDetailsInput!`
`verified` - `Boolean!`
`consent` - `Boolean!`
`captchaToken` - `String!`

Example

{
  "complainant": ReportCampaignComplainantInput,
  "details": ReportCampaignDetailsInput,
  "verified": false,
  "consent": true,
  "captchaToken": "xyz789"
}

Types

ReportCampaignPayload

Fields

Field Name	Description
`submitted` - `Boolean!`
`message` - `String`

Example

{"submitted": false, "message": "xyz789"}

Types

ReportCampaignReasonType

Values

Enum Value	Description
`Defamatory`
`Copyright`
`Fraudulent`
`Spam`
`Other`

Example

"Defamatory"

Types

ReportCampaignSubjectType

Values

Enum Value	Description
`Page`
`Image`
`Comment`
`Other`

Example

"Page"

Types

ResetPasswordPayload

Fields

Field Name	Description
`ok` - `Boolean!`

Example

{"ok": false}

Types

RevertCampaignInput

Fields

Input Field	Description
`id` - `ID!`
`reason` - `String`

Example

{"id": 4, "reason": "xyz789"}

Types

RevertCampaignPayload

Fields

Field Name	Description
`campaign` - `Campaign!`

Example

{"campaign": Campaign}

Types

Schedule

Fields

Field Name	Description
`id` - `ID!`
`currentAt` - `Date!`
`startAt` - `Date!`
`frequency` - `PaymentFrequencyRecurring!`
`amount` - `MoneyNode!`
`optionalDonation` - `MoneyNode!`
`fees` - `MoneyNode!`
`instalments` - `InstalmentConnection!`

Example

{
  "id": "4",
  "currentAt": "2007-12-03",
  "startAt": "2007-12-03",
  "frequency": "Weekly",
  "amount": MoneyNode,
  "optionalDonation": MoneyNode,
  "fees": MoneyNode,
  "instalments": InstalmentConnection
}

Types

Settings

Fields

Field Name	Description
`vendor` - `SettingsVendor!`

Example

{"vendor": SettingsVendor}

Types

SettingsVendor

Fields

Field Name	Description
`launchDarklyClientKey` - `String!`

Example

{"launchDarklyClientKey": "abc123"}

Types

SignupInput

Fields

Input Field	Description
`name` - `String!`
`email` - `Email!`
`password` - `String`

Example

{
  "name": "xyz789",
  "email": Email,
  "password": "abc123"
}

Types

SignupPayload

Fields

Field Name	Description
`user` - `User`
`ok` - `Boolean!`

Example

{"user": User, "ok": true}

Types

SocialPlatform

Values

Enum Value	Description
`Twitter`
`Facebook`

Example

"Twitter"

Types

SortableDirection

Values

Enum Value	Description
`Ascending`
`Descending`

Example

"Ascending"

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"abc123"

Types

Survey

Fields

Field Name	Description
`id` - `ID!`
`campaign` - `Campaign!`
`netPromoterScore` - `Int`
`bestExperience` - `String`
`worstExperience` - `String`
`isCompleted` - `Boolean!`
`triggeredBy` - `SurveyEvent!`

Example

{
  "id": "4",
  "campaign": Campaign,
  "netPromoterScore": 123,
  "bestExperience": "xyz789",
  "worstExperience": "abc123",
  "isCompleted": false,
  "triggeredBy": "CampaignCompleted"
}

Types

SurveyEvent

Values

Enum Value	Description
`CampaignCompleted`
`CampaignSubmitted`
`CampaignApproved`

Example

"CampaignCompleted"

Types

SyncCampaignIntegrationInput

Fields

Input Field	Description
`id` - `ID!`
`type` - `IntegrationType!`

Example

{"id": "4", "type": "ACTION_NETWORK"}

Types

SyncCampaignIntegrationPayload

Fields

Field Name	Description
`campaign` - `Campaign!`
`ok` - `Boolean!`

Example

{"campaign": Campaign, "ok": false}

Types

Team

Fields

Field Name	Description
`id` - `ID!`
`campaign` - `Campaign!`
`fundraisers` - `FundraiserConnection!`
Arguments `filter` - `FundraiserFilterInput` `first` - `Int` `after` - `ID`
`title` - `String!`
`slug` - `String!`
`target` - `MoneyNode!`
`logo` - `URL!`
`status` - `TeamStatus!`

Example

{
  "id": "4",
  "campaign": Campaign,
  "fundraisers": FundraiserConnection,
  "title": "xyz789",
  "slug": "xyz789",
  "target": MoneyNode,
  "logo": "http://www.test.com/",
  "status": "Confirmed"
}

Types

TeamMember

Fields

Field Name	Description
`name` - `String!`
`email` - `String!`
`image` - `Asset`

Example

{
  "name": "abc123",
  "email": "abc123",
  "image": Asset
}

Types

TeamStatus

Values

Enum Value	Description
`Confirmed`

Example

"Confirmed"

Types

TransferUserResourcesInput

Fields

Input Field	Description
`ownerId` - `ID!`
`recipientId` - `ID!`

Example

{"ownerId": 4, "recipientId": "4"}

Types

TransferUserResourcesPayload

Fields

Field Name	Description
`recipient` - `User!`

Example

{"recipient": User}

Types

Translation

Fields

Field Name	Description
`key` - `TranslationKey!`
`language` - `Language!`
`translation` - `String!`

Example

{
  "key": TranslationKey,
  "language": Language,
  "translation": "abc123"
}

Types

TranslationKey

Fields

Field Name	Description
`id` - `ID!`

Example

{"id": 4}

Types

URL

Example

"http://www.test.com/"

Types

UTMTags

Fields

Field Name	Description
`uri` - `URL!`
`source` - `String!`
`medium` - `String!`
`campaign` - `String!`
`term` - `String!`
`content` - `String!`

Example

{
  "uri": "http://www.test.com/",
  "source": "xyz789",
  "medium": "xyz789",
  "campaign": "abc123",
  "term": "abc123",
  "content": "abc123"
}

Types

UnlinkCampaignTrackingCodeToAmplifyCampaignInput

Fields

Input Field	Description
`campaignId` - `ID!`
`code` - `String!`
`amplifyVendorCampaignId` - `ID`

Example

{
  "campaignId": "4",
  "code": "xyz789",
  "amplifyVendorCampaignId": "4"
}

Types

UnlinkCampaignTrackingCodeToAmplifyCampaignPayload

Fields

Field Name	Description
`trackingCode` - `CampaignTrackingCode!`

Example

{"trackingCode": CampaignTrackingCode}

Types

UnlinkFundraiserTeamInput

Fields

Input Field	Description
`fundraiserId` - `ID!`
`teamId` - `ID!`

Example

{"fundraiserId": 4, "teamId": "4"}

Types

UnlinkFundraiserTeamPayload

Fields

Field Name	Description
`team` - `Team!`
`fundraiser` - `Fundraiser!`

Example

{
  "team": Team,
  "fundraiser": Fundraiser
}

Types

UpdateCampaignAmplifyReceiptInput

Fields

Input Field	Description
`id` - `ID!`
`invoiceUrl` - `String!`

Example

{
  "id": "4",
  "invoiceUrl": "xyz789"
}

Types

UpdateCampaignAmplifyStatusInput

Fields

Input Field	Description
`campaignId` - `ID!`
`amplifyStatus` - `String`

Example

{"campaignId": 4, "amplifyStatus": "abc123"}

Types

UpdateCampaignAmplifyStatusPayload

Fields

Field Name	Description
`campaignAmplifyStatus` - `CampaignAmplifyStatus`

Example

{"campaignAmplifyStatus": CampaignAmplifyStatus}

Types

UpdateCampaignDonationFormInput

Fields

Input Field	Description
`campaignId` - `ID!`
`defaultPaymentMethod` - `PaymentFrequency`
`template` - `DonationFormTemplate`

Example

{
  "campaignId": 4,
  "defaultPaymentMethod": "OneOff",
  "template": DonationFormTemplate
}

Types

UpdateCampaignDonationFormPayload

Fields

Field Name	Description
`campaign` - `Campaign!`
`donationForm` - `DonationForm!`

Example

{
  "campaign": Campaign,
  "donationForm": DonationForm
}

Types

UpdateCampaignDonationFormTemplateInput

Fields

Input Field	Description
`campaignId` - `ID!`
`logo` - `String`
`backgroundImage` - `String`
`backgroundColor` - `Color`
`headerColor` - `Color`
`content` - `String`
`successMessage` - `String`
`returnUrl` - `URL`

Example

{
  "campaignId": "4",
  "logo": "abc123",
  "backgroundImage": "xyz789",
  "backgroundColor": Color,
  "headerColor": Color,
  "content": "abc123",
  "successMessage": "xyz789",
  "returnUrl": "http://www.test.com/"
}

Types

UpdateCampaignDonationFormTemplatePayload

Fields

Field Name	Description
`template` - `DonationFormTemplate`

Example

{"template": DonationFormTemplate}

Types

UpdateCampaignInput

Fields

Input Field	Description
`id` - `ID!`
`status` - `CampaignStatus`
`startAt` - `Date`
`finishAt` - `Date`
`campCategory` - `String`

Example

{
  "id": "4",
  "status": "Live",
  "startAt": "2007-12-03",
  "finishAt": "2007-12-03",
  "campCategory": "abc123"
}

Types

UpdateCampaignIntegrationInput

Fields

Input Field	Description
`campaignId` - `ID!`
`type` - `IntegrationType!`
`config` - `Object`
`token` - `String`
`reference` - `String`

Example

{
  "campaignId": 4,
  "type": "ACTION_NETWORK",
  "config": Object,
  "token": "xyz789",
  "reference": "abc123"
}

Types

UpdateCampaignIntegrationPayload

Fields

Field Name	Description
`integration` - `CampaignIntegration!`

Example

{"integration": CampaignIntegration}

Types

UpdateCampaignPayload

Fields

Field Name	Description
`campaign` - `Campaign!`

Example

{"campaign": Campaign}

Types

UpdateCampaignSettingsInput

Fields

Input Field	Description
`campaignId` - `ID!`
`isCommentsEnabled` - `Boolean`
`isCustomDonationFormEnabled` - `Boolean`

Example

{
  "campaignId": 4,
  "isCommentsEnabled": true,
  "isCustomDonationFormEnabled": true
}

Types

UpdateCampaignSettingsPayload

Fields

Field Name	Description
`campaignSettings` - `CampaignSettings!`

Example

{"campaignSettings": CampaignSettings}

Types

UpdateCampaignUpdateInput

Fields

Input Field	Description
`id` - `ID!`
`title` - `String!`
`content` - `String!`
`assets` - `[CampaignUpdateAssetInput]`

Example

{
  "id": 4,
  "title": "abc123",
  "content": "abc123",
  "assets": [CampaignUpdateAssetInput]
}

Types

UpdateCampaignUpdatePayload

Fields

Field Name	Description
`ok` - `Boolean!`
`id` - `ID!`

Example

{"ok": false, "id": "4"}

Types

UpdateCommentInput

Fields

Input Field	Description
`id` - `ID!`
`content` - `Markup`
`status` - `CommentStatus`

Example

{"id": 4, "content": Markup, "status": "Published"}

Types

UpdateCommentPayload

Fields

Field Name	Description
`comment` - `Comment!`

Example

{"comment": Comment}

Types

UpdateDonationInput

Fields

Input Field	Description
`id` - `ID!`
`visibility` - `DonationVisibility`
`name` - `String`

Example

{
  "id": 4,
  "visibility": "Anonymous",
  "name": "xyz789"
}

Types

UpdateDonationPayload

Fields

Field Name	Description
`donation` - `Donation!`

Example

{"donation": Donation}

Types

UpdateFundraiserInput

Fields

Input Field	Description
`id` - `ID!`
`content` - `String`
`target` - `Money`
`slug` - `String`
`fundraiserName` - `String`
`fundraiserEmail` - `Email`
`fundraiserProfile` - `URL`
`video` - `URL`

Example

{
  "id": "4",
  "content": "abc123",
  "target": Money,
  "slug": "xyz789",
  "fundraiserName": "abc123",
  "fundraiserEmail": Email,
  "fundraiserProfile": "http://www.test.com/",
  "video": "http://www.test.com/"
}

Types

UpdateFundraiserPayload

Fields

Field Name	Description
`fundraiser` - `Fundraiser!`

Example

{"fundraiser": Fundraiser}

Types

UpdateLandingPageInput

Fields

Input Field	Description
`id` - `ID!`
`title` - `String`
`description` - `String`
`isActive` - `Boolean`
`slug` - `String`
`image` - `URL`
`theme` - `String`
`countries` - `String`
`styles` - `String`

Example

{
  "id": 4,
  "title": "abc123",
  "description": "xyz789",
  "isActive": true,
  "slug": "abc123",
  "image": "http://www.test.com/",
  "theme": "xyz789",
  "countries": "abc123",
  "styles": "abc123"
}

Types

UpdateLandingPagePayload

Fields

Field Name	Description
`landingPage` - `LandingPage!`

Example

{"landingPage": LandingPage}

Types

UpdateMovementInput

Fields

Input Field	Description
`id` - `ID!`
`title` - `String`
`slug` - `String`
`heading` - `String`
`description` - `String`
`image` - `Upload`

Example

{
  "id": "4",
  "title": "abc123",
  "slug": "xyz789",
  "heading": "abc123",
  "description": "abc123",
  "image": Upload
}

Types

UpdateMovementPayload

Fields

Field Name	Description
`movement` - `Movement!`

Example

{"movement": Movement}

Types

UpdateRegularGivingInput

Fields

Input Field	Description
`id` - `ID!`
`frequency` - `PaymentFrequencyRecurring`
`amount` - `Money`
`optionalDonation` - `Money`

Example

{
  "id": 4,
  "frequency": "Weekly",
  "amount": Money,
  "optionalDonation": Money
}

Types

UpdateRegularGivingPayload

Fields

Field Name	Description
`regularGiving` - `RegularGiving!`

Example

{"regularGiving": RegularGiving}

Types

UpdateRegularGivingPaymentMethodInput

Fields

Input Field	Description
`id` - `ID!`
`vendor` - `PaymentMethodVendor!`
`type` - `PaymentMethodType!`
`reference` - `String!`

Example

{
  "id": "4",
  "vendor": "Stripe",
  "type": "Card",
  "reference": "abc123"
}

Types

UpdateRegularGivingPaymentMethodPayload

Fields

Field Name	Description
`status` - `ProcessPaymentStatus!`
`statusUri` - `String`

Example

{"status": "Success", "statusUri": "xyz789"}

Types

UpdateTranslationInput

Fields

Input Field	Description
`translationKeyId` - `ID!`
`languageId` - `ID!`
`translation` - `String!`

Example

{
  "translationKeyId": "4",
  "languageId": 4,
  "translation": "xyz789"
}

Types

UpdateTranslationPayload

Fields

Field Name	Description
`translation` - `Translation!`

Example

{"translation": Translation}

Types

UpdateUserInput

Fields

Input Field	Description
`id` - `ID!`
`firstName` - `String`
`lastName` - `String`
`email` - `Email`

Example

{
  "id": 4,
  "firstName": "abc123",
  "lastName": "xyz789",
  "email": Email
}

Types

UpdateUserPayload

Fields

Field Name	Description
`user` - `User!`

Example

{"user": User}

Types

Upload

Example

Upload

Types

User

Fields

Field Name	Description
`id` - `ID!`
`email` - `Email!`
`title` - `String`
`firstName` - `String!`
`lastName` - `String!`
`phone` - `Phone`
`address` - `Address`
`profileImage` - `URL`
`isAdmin` - `Boolean!`
`isVerified` - `Boolean!`
`isAutoApproved` - `Boolean!`
`donations` - `DonationConnection!`
Arguments `filter` - `DonationFilterInput` `first` - `Int` `after` - `ID` `sort` - `[DonationSortableInput!]`
`regularGivings` - `[RegularGiving!]!`
`paymentMethods` - `[UserPaymentMethod!]!`
`comments` - `CommentConnection!`
Arguments `first` - `Int` `after` - `ID`

Example

{
  "id": 4,
  "email": Email,
  "title": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "phone": Phone,
  "address": Address,
  "profileImage": "http://www.test.com/",
  "isAdmin": true,
  "isVerified": true,
  "isAutoApproved": false,
  "donations": DonationConnection,
  "regularGivings": [RegularGiving],
  "paymentMethods": [UserPaymentMethod],
  "comments": CommentConnection
}

Types

UserConnection

Fields

Field Name	Description
`totalCount` - `Int!`
`pageInfo` - `PageInfo!`
`edges` - `[UserEdge!]!`

Example

{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [UserEdge]
}

Types

UserEdge

Fields

Field Name	Description
`cursor` - `String!`
`node` - `User!`

Example

{
  "cursor": "xyz789",
  "node": User
}

Types

UserExistsPayload

Fields

Field Name	Description
`ok` - `Boolean!`

Example

{"ok": false}

Types

UserFilterInput

Fields

Input Field	Description
`query` - `String`

Example

{"query": "xyz789"}

Types

UserPaymentMethod

Fields

Field Name	Description
`id` - `ID!`
`user` - `User!`
`vendor` - `PaymentMethodVendor!`
`details` - `Object`

Example

{
  "id": "4",
  "user": User,
  "vendor": "Stripe",
  "details": Object
}

Types

Webhook

Fields

Field Name	Description
`id` - `ID!`
`url` - `URL!`
`description` - `String!`
`events` - `[WebhookEvent!]!`
`attempts` - `[WebhookAttempt!]!`

Example

{
  "id": "4",
  "url": "http://www.test.com/",
  "description": "xyz789",
  "events": [WebhookEvent],
  "attempts": [WebhookAttempt]
}

Types

WebhookAttempt

Fields

Field Name	Description
`webhook` - `Webhook!`
`event` - `WebhookEvent!`
`request` - `String!`
`statusCode` - `Int`
`response` - `String`
`attempt` - `Int!`
`sentAt` - `Date!`

Example

{
  "webhook": Webhook,
  "event": WebhookEvent,
  "request": "abc123",
  "statusCode": 123,
  "response": "abc123",
  "attempt": 987,
  "sentAt": "2007-12-03"
}

Types

WebhookEvent

Fields

Field Name	Description
`id` - `ID!`
`label` - `String!`
`description` - `String!`

Example

{
  "id": 4,
  "label": "xyz789",
  "description": "xyz789"
}