Sign in

v13

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-29231692.6 KB
unintegrated_grants

Update Unintegrated Grant

Update an unintegrated grant object with the given ID. This can be used to update the status or acknowledgement of the unintegrated grant.

patch/v1/unintegrated_grants/{id}

Path parameters

idstring uuid required

The unique id of the unintegrated grant. The format should be a v4 UUID according to RFC 4122.

Request body

status'Initiated' | 'Completed' required

The status of the grant:

  • Initiated: The grant has been initiated and is ready to be processed
  • Completed: The grant has been completed
acknowledgedAtstring date-time

The date and time the grant was acknowledged by the nonprofit. This is useful for nonprofits to indicate when they have received and processed the grant. Expressed in RFC 3339 format.

Example request

{
  "status": "Completed",
  "acknowledgedAt": "2020-01-31T23:00:00Z"
}

Response

OK

idstring uuid required

The unique identifier for the object

userFriendlyIdstring

Often refered to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

trackingIdstring

The tracking ID for the unintegrated grant

workflowSessionIdstring uuid required

ID of the Connect Workflow Session associated with this grant

fundIdstring required

ID of the donor advised fund

createdAtstring date-time

Time when this object was created; expressed in RFC 3339 format

updatedAtstring date-time

Time when this object was last updated; expressed in RFC 3339 format

amountnumber required

The grant amount expressed in units of whole cents

status'Unknown' | 'Initiated' | 'Completed' | 'Canceled'

The status of the unintegrated grant. To see a description of each status, see the "Unintegrated Grant Statuses" section of the Chariot documentation.

metadataobject

A map of arbitrary string keys and values to store information about the object

firstNamestring

The donor's first name

lastNamestring

The donor's last name

phonestring

The donor's phone number

emailstring

The donor's email

notestring

An note inputted by the user at submisson

paymentChannel'offline'

The payment channel for the unintegrated grant. This is useful to know how the grant will be sent. The payment channel for unintegrated grants will always be:

  • offline: Grant was initiated outside of Chariot so we're unable to confirm how the grant will be sent.

Example response

{
  "id": "cfe09e64-6a74-4dab-a565-361185a6f248",
  "userFriendlyId": "1234455",
  "trackingId": "L9E182VBGP",
  "workflowSessionId": "2d4b2a43-a5b4-4be1-ad1f-f932016ca4a6",
  "fundId": "daf-id",
  "createdAt": "2020-01-31T23:00:00Z",
  "updatedAt": "2020-01-31T23:59:59Z",
  "amount": 15000,
  "status": "Initiated",
  "firstName": "Warren",
  "lastName": "Buffet",
  "phone": "1237861020",
  "email": "warrenBuffet@example.com",
  "note": "Please dedicate in memory of grandma",
  "paymentChannel": "offline"
}