Import pledge card data for review

curl --request POST \
  --url https://api.grainledger.com/api/v1/pledge-card-imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "cards": [
    {
      "externalId": "882145",
      "rockPersonId": "34567",
      "rockAccountId": "204",
      "rockCampusId": "3",
      "donorFirstName": "Sarah",
      "donorLastName": "Johnson",
      "donorEmail": "sarah@example.org",
      "amount": 12000,
      "frequency": "MONTHLY",
      "startDate": "2027-01-01",
      "endDate": "2027-12-31"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cards: [
      {
        externalId: '882145',
        rockPersonId: '34567',
        rockAccountId: '204',
        rockCampusId: '3',
        donorFirstName: 'Sarah',
        donorLastName: 'Johnson',
        donorEmail: 'sarah@example.org',
        amount: 12000,
        frequency: 'MONTHLY',
        startDate: '2027-01-01',
        endDate: '2027-12-31'
      }
    ]
  })
};

fetch('https://api.grainledger.com/api/v1/pledge-card-imports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.grainledger.com/api/v1/pledge-card-imports"

payload = { "cards": [
        {
            "externalId": "882145",
            "rockPersonId": "34567",
            "rockAccountId": "204",
            "rockCampusId": "3",
            "donorFirstName": "Sarah",
            "donorLastName": "Johnson",
            "donorEmail": "sarah@example.org",
            "amount": 12000,
            "frequency": "MONTHLY",
            "startDate": "2027-01-01",
            "endDate": "2027-12-31"
        }
    ] }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "scanGroupId": "<string>",
  "batchId": "<string>",
  "reviewUrl": "<string>",
  "idempotentReplay": true,
  "sourceFileAttachmentId": "<string>",
  "cardsImported": 1,
  "cardsSkipped": 1,
  "cardsWithIssues": 1,
  "duplicateCards": 1,
  "items": [
    {
      "itemId": "<string>",
      "externalId": "<string>",
      "rockPersonId": "<string>",
      "rockAccountId": "<string>",
      "issue": "<string>",
      "duplicateOfId": "<string>"
    }
  ]
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

POST

https://api.grainledger.com

api

pledge-card-imports

Import pledge card data for review

curl --request POST \
  --url https://api.grainledger.com/api/v1/pledge-card-imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "cards": [
    {
      "externalId": "882145",
      "rockPersonId": "34567",
      "rockAccountId": "204",
      "rockCampusId": "3",
      "donorFirstName": "Sarah",
      "donorLastName": "Johnson",
      "donorEmail": "sarah@example.org",
      "amount": 12000,
      "frequency": "MONTHLY",
      "startDate": "2027-01-01",
      "endDate": "2027-12-31"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cards: [
      {
        externalId: '882145',
        rockPersonId: '34567',
        rockAccountId: '204',
        rockCampusId: '3',
        donorFirstName: 'Sarah',
        donorLastName: 'Johnson',
        donorEmail: 'sarah@example.org',
        amount: 12000,
        frequency: 'MONTHLY',
        startDate: '2027-01-01',
        endDate: '2027-12-31'
      }
    ]
  })
};

fetch('https://api.grainledger.com/api/v1/pledge-card-imports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.grainledger.com/api/v1/pledge-card-imports"

payload = { "cards": [
        {
            "externalId": "882145",
            "rockPersonId": "34567",
            "rockAccountId": "204",
            "rockCampusId": "3",
            "donorFirstName": "Sarah",
            "donorLastName": "Johnson",
            "donorEmail": "sarah@example.org",
            "amount": 12000,
            "frequency": "MONTHLY",
            "startDate": "2027-01-01",
            "endDate": "2027-12-31"
        }
    ] }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "scanGroupId": "<string>",
  "batchId": "<string>",
  "reviewUrl": "<string>",
  "idempotentReplay": true,
  "sourceFileAttachmentId": "<string>",
  "cardsImported": 1,
  "cardsSkipped": 1,
  "cardsWithIssues": 1,
  "duplicateCards": 1,
  "items": [
    {
      "itemId": "<string>",
      "externalId": "<string>",
      "rockPersonId": "<string>",
      "rockAccountId": "<string>",
      "issue": "<string>",
      "duplicateOfId": "<string>"
    }
  ]
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

{
  "message": "You do not have access to this organization."
}

Authorizations

Authorization

string

header

required

Organization API key created in Grain Settings → API. The key determines the organization and is limited to its assigned resource scopes. Write scopes imply the corresponding read scope.

Headers

X-Organization-Id

string

Required with OAuth access tokens. Optional with organization API keys; if supplied, it must match the key's organization.

Idempotency-Key

string

required

A unique key for this import request. Retrying the same body with the same key returns the original import without creating duplicate rows.

Required string length: 1 - 255

Body

application/json

cards

object[]

required

Required array length: 1 - 500 elements

Hide child attributes

cards.externalId

string

Maximum string length: 128

Example:

"card-1001"

cards.rockPersonId

string

Current Rock Person.Id. Exact identity routing bypasses fuzzy donor matching.

Maximum string length: 128

cards.donorFirstName

string

Maximum string length: 100

Example:

"Sarah"

cards.donorLastName

string

Maximum string length: 100

Example:

"Johnson"

cards.donorEmail

string<email>

Maximum string length: 255

Example:

"sarah@example.org"

cards.donorPhone

string

Maximum string length: 50

Example:

"+1 615 555 0100"

cards.donorAddress

string

Maximum string length: 255

Example:

"100 Church Street"

cards.donorAddress2

string

Second street-address line. Grain joins both lines with one space for donor matching while preserving both in the import artifact.

Maximum string length: 255

Example:

"Suite 200"

cards.donorCity

string

Maximum string length: 100

Example:

"Nashville"

cards.donorState

string

Maximum string length: 100

Example:

"TN"

cards.donorZip

string

Maximum string length: 20

Example:

"37201"

cards.amount

number

Required range: x >= 0

Example:

12000

cards.frequency

enum<string>

Available options:

ONE_TIME,

WEEKLY,

BIWEEKLY,

MONTHLY,

QUARTERLY,

ANNUALLY

Example:

"MONTHLY"

cards.fundId

string

Optional per-card Grain fund ID. Do not send with rockAccountId.

cards.rockAccountId

string

Exact Rock financial account ID for this card. Do not send with fundId.

Maximum string length: 128

cards.fundName

string

Informational label shown during review. It is never used for fund routing or fallback.

Maximum string length: 200

cards.campusId

string

deprecated

Legacy internal Grain campus ID. Do not send with rockCampusId.

cards.rockCampusId

string

Exact Rock campus ID resolved through the integration campus catalog. Campus does not select a financial account.

Maximum string length: 128

cards.campusName

string

Legacy campus label used by the existing review matcher. Use rockCampusId for exact routing.

Maximum string length: 200

cards.startDate

string<date>

Example:

"2027-01-01"

cards.endDate

string<date>

Example:

"2027-12-31"

cards.notes

string

Maximum string length: 2000

scanGroupId

string

Existing pledge card scan group ID. When set, cards are added as a new batch in that group. campaignId is inherited; a supplied request default fund or Rock account overrides the group's default.

name

string

Required when scanGroupId is omitted. Becomes the new scan group name.

Required string length: 1 - 100

Example:

"2027 annual pledge cards"

defaultFundId

string

Grain fund used when a card has no override. Required when scanGroupId is omitted unless defaultRockAccountId is supplied.

defaultRockAccountId

string

Exact Rock financial account used when a card has no override. Do not send with defaultFundId.

campaignId

string

Optional Grain pledge campaign ID. Ignored when scanGroupId is set; the group's campaign is used instead.

pledgeAudience

enum<string>

default:ADULT

Available options:

ADULT,

STUDENT

Response

Pledge card data imported for review

scanGroupId

string

required

batchId

string

required

reviewUrl

string<uri>

required

idempotentReplay

boolean

required

sourceFileAttachmentId

string

required

Secured audit artifact ID; not a scanned card attachment

cardsImported

integer

required

Required range: x >= 0

cardsSkipped

integer

required

Required range: x >= 0

cardsWithIssues

integer

required

Required range: x >= 0

duplicateCards

integer

required

Required range: x >= 0

items

object[]

required

Hide child attributes

items.itemId

string

items.externalId

string | null

items.rockPersonId

string | null

items.rockAccountId

string | null

items.sourceIdentityStatus

enum<string> | null

Available options:

PENDING,

MATCHED,

CONFLICT,

NOT_FOUND

items.status

enum<string>

Available options:

EXTRACTED,

SKIPPED

items.issue

string | null

items.duplicateOfId

string | null

Last modified on July 15, 2026

Update contribution List pledge card import reference data

Transactions

Bills

Donors

Contributions

Pledge Card Imports

Pledges

Households

Import pledge card data for review

Authorizations

Headers

Body

Response