Campaign

Campaign (Model)

  • accent_color
    Type: string
  • accepts_cash_donations
    Type: boolean
  • accepts_crypto_donations
    Type: boolean
  • accepts_daf_donations
    Type: boolean
  • accepts_endowment_donations
    Type: boolean
  • accepts_stock_donations
    Type: boolean
  • acknowledgement_message
    Type: string
  • content_header
    Type: string
  • cover_image
    Type: object · Document

    Document (Model)

    • account
      Type: object · Account

      Account (Model)

    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • deleted_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • id
      Type: string
    • mime_type
      Type: stringenum
      values
      • application/pdf
      • image/png
      • image/jpeg
      • image/webp
    • name
      Type: string
    • organization
      Type: object · Organization

      Organization (Model)

    • type
      Type: stringenum
      values
      • w9
      • ips
      • articles_of_incorporation
      • board_report
      • meeting_minutes
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • url
      Type: string
  • created_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • designations
    Type: array object[] · CampaignDesignation[]

    CampaignDesignation (Model)

    • campaign
      Type: object · Campaign

      Campaign (Model)

    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • deleted_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • id
      Type: string
    • name
      Type: string
    • priority
      Type: number
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • donation_count
    Type: number
  • donations
    Type: array object[] · Donation[]

    Donation (Model)

    • asset
      Type: object · Asset

      Asset (Model)

    • async_get_apex_activity_this
      Type: object · Donation

      Donation (Model)

    • async_get_receive_date_this
      Type: object · Donation

      Donation (Model)

    • campaign
      Type: object · Campaign

      Campaign (Model)

    • cancelation_reason
      Type: stringenum
      values
      • duplicate
      • donor_cancel
      • other
    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • designation
      Type: object · CampaignDesignation

      CampaignDesignation (Model)

    • donor_address_line_1
      Type: string
    • donor_address_line_2
      Type: string
    • donor_city
      Type: string
    • donor_country
      Type: string · CountryCodeenum nullable

      ISO 3166-1 alpha-2 country code

      values
      • ad
      • ae
      • af
      • ag
      • ai
    • donor_email
      Type: string
    • donor_first_name
      Type: string
    • donor_last_name
      Type: string
    • donor_postal_code
      Type: string
    • donor_province
      Type: string
    • id
      Type: string
    • identifier
      Type: string
    • is_recurring
      Type: boolean
    • memo
      Type: string
    • organization
      Type: object · Organization

      Organization (Model)

    • payment
      Type: object · DonationPayment

      DonationPayment (Interface)

    • payout
      Type: object · Withdrawal

      Withdrawal (Model)

    • quantity
      Type: number
    • recognition
      Type: stringenum
      values
      • public
      • private
      • anonymous
    • source
      Type: string
    • status
      Type: stringenum
      values
      • pledged
      • pending
      • processing
      • complete
      • failed
    • tax_deductible_amount
      Type: number
    • trade
      Type: object · Trade

      Trade (Model)

    • type
      Type: stringenum
      values
      • currency
      • stock
      • crypto
      • daf
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • goal
    Type: number
  • id
    Type: string
  • legacy_cash_url
    Type: string
  • logo
    Type: object · Document

    Document (Model)

    • account
      Type: object · Account

      Account (Model)

    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • deleted_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • id
      Type: string
    • mime_type
      Type: stringenum
      values
      • application/pdf
      • image/png
      • image/jpeg
      • image/webp
    • name
      Type: string
    • organization
      Type: object · Organization

      Organization (Model)

    • type
      Type: stringenum
      values
      • w9
      • ips
      • articles_of_incorporation
      • board_report
      • meeting_minutes
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • url
      Type: string
  • name
    Type: string
  • organization
    Type: object · Organization

    Organization (Model)

    • accounts
      Type: array object[] · Account[]

      Account (Model)

    • address_line_1
      Type: string
    • address_line_2
      Type: string
    • advisor
      Type: object · Advisor

      Advisor (Model)

    • annual_income
      Type: stringenum
      values
      • under_25k
      • from_25k_to_50k
      • from_50k_to_100k
      • from_100k_to_200k
      • from_200k_to_300k
      • from_300k_to_500k
      • from_500k_to_1200k
      • over_1200k
    • anticipated_crypto_volume
      Type: stringenum
      values
      • less_than_5k
      • 5k_to_10k
      • 10k_to_100k
      • 100k_to_500k
      • 500k_to_1m
      • over_1m
      • null
    • articles_of_incorporation
      Type: object · Document

      Document (Model)

    • balance
      Type: number
    • board_approval_agenda
      Type: string
    • board_approval_attendees
      Type: string
    • board_approved_account_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • board_resolution_consent_event
      Type: object · ConsentEvent

      ConsentEvent (Model)

    • board_resolution_minutes
      Type: object · Document

      Document (Model)

    • board_secretary_email
      Type: string
    • board_secretary_first_name
      Type: string
    • board_secretary_last_name
      Type: string
    • board_secretary_title
      Type: string
    • brand_color
      Type: string
    • campaigns
      Type: array object[] · Campaign[]

      Campaign (Model)

    • capabilities
      Type: object · Capabilities

      Capabilities (Interface)

    • cash_balance
      Type: number
    • city
      Type: string
    • corporate_bylaws
      Type: object · Document

      Document (Model)

    • country
      Type: string · CountryCodeenum nullable

      ISO 3166-1 alpha-2 country code

      values
      • ad
      • ae
      • af
      • ag
      • ai
    • created_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • crypto_consent_event
      Type: object · ConsentEvent

      ConsentEvent (Model)

    • documents
      Type: array object[] · Document[]

      Document (Model)

    • doing_business_as
      Type: array string[]
    • donations
      Type: array object[] · Donation[]

      Donation (Model)

    • donor_address_requirement_asset_threshold
      Type: number
    • donor_address_requirement_threshold
      Type: number
    • donor_base
      Type: array string[]enum
      values
      • us_individuals
      • us_corporations
      • us_government_grants
      • foreign_government_grants
      • foreign_individuals
      • foreign_corporations
    • equities_balance
      Type: number
    • exemption_type
      Type: stringenum
      values
      • 501c1
      • 501c2
      • 501c3
      • 501c4
      • 501c5
    • external_accounts
      Type: array object[] · ExternalAccount[]

      ExternalAccount (Model)

    • foreign_bank_us_agent
      Type: string
    • id
      Type: string
    • incorporation_country
      Type: string · CountryCodeenum nullable

      ISO 3166-1 alpha-2 country code

      values
      • ad
      • ae
      • af
      • ag
      • ai
    • incorporation_date
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • incorporation_province
      Type: string
    • invitations
      Type: array object[] · Invitation[]

      Invitation (Model)

    • irs_data
      Type: object · IrsDatum

      IrsDatum (Model)

    • irs_determination
      Type: object · Document

      Document (Model)

    • is_foreign_bank_maintained
      Type: boolean
    • legal_name
      Type: string
    • liquid_net_worth
      Type: stringenum
      values
      • under_50k
      • from_50k_to_100k
      • from_100k_to_200k
      • from_200k_to_500k
      • from_500k_to_1m
      • from_1m_to_5m
      • over_5m
    • logo
      Type: object · Document

      Document (Model)

    • major_donors
      Type: array object[] · MajorDonors[]

      MajorDonors (Interface)

    • mission
      Type: string
    • name
      Type: string
    • negative_news
      Type: string
    • net_worth
      Type: stringenum
      values
      • under_50k
      • from_50k_to_100k
      • from_100k_to_200k
      • from_200k_to_500k
      • from_500k_to_1m
      • from_1m_to_5m
      • over_5m
    • operating_countries
      Type: array · CountryCodeNullable[]
    • organization_integrations
      Type: array object[] · OrganizationIntegration[]

      OrganizationIntegration (Model)

    • phone
      Type: string
    • politically_exposed_people
      Type: array object[] · PoliticallyExposedPeople[]

      PoliticallyExposedPeople (Interface)

    • postal_code
      Type: string
    • province
      Type: string
    • structure
      Type: stringenum
      values
      • trust
      • corporation
      • limited_liability_company
    • tax_id
      Type: string
    • updated_at
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • url
      Type: string
    • users
      Type: array object[] · User[]

      User (Model)

    • w_9
      Type: object · Document

      Document (Model)

    • webhooks
      Type: array object[] · Webhook[]

      Webhook (Model)

  • page_content
    Type: string
  • page_title
    Type: string
  • revenue
    Type: number
  • slug
    Type: string
  • status
    Type: stringenum
    values
    • draft
    • active
    • archived
  • suggested_amount_1
    Type: number
  • suggested_amount_2
    Type: number
  • suggested_amount_3
    Type: number
  • suggested_amount_4
    Type: number
  • updated_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • white_listed_domains
    Type: string