FundraisingGrants

Update Grant

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

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequiredformat: "uuid"
The unique id of the grant. The format should be a v4 UUID according to RFC 4122.

Request

The request to update a grant. This is useful to update the status of a grant. The request should specify the grant status.
statusenumRequired
The status of the grant: * Initiated: The grant has been initiated and is ready to be processed * Completed: The grant has been completed
Allowed values:
acknowledgedAtdatetimeOptional
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.

Response headers

X-Request-IdstringOptional
The unique identifier for the request

Response

OK
idstringRead-onlyformat: "uuid"
The unique identifier for the object
workflowSessionIdstringRead-onlyformat: "uuid"
ID of the Connect Workflow Session associated with this grant
fundIdstringRead-only
ID of the donor advised fund
amountdouble
The grant amount expressed in units of whole cents
trackingIdstringOptionalRead-only
The tracking ID for the grant
externalGrantIdstringOptional
ID of the grant associated with the donor advised fund
createdAtdatetimeOptionalRead-only

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

updatedAtdatetimeOptionalRead-only

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

statusstringOptional
The status of the grant
feeDetailobjectOptionalRead-only
The fee detail of the grant
metadatamap from strings to stringsOptional
A map of arbitrary string keys and values to store information about the object
firstNamestringOptional
The donor's first name
lastNamestringOptional
The donor's last name
phonestringOptional
The donor's phone number
emailstringOptional
The donor's email
notestringOptional
An note inputted by the user at submisson
statuseslist of objectsOptional
The list of grant statuses for this grant
paymentChannelenumOptionalRead-only

The payment channel for the grant. This is useful to know how the grant will be sent. The payment channel will be one of the following:

  • dafpay_network: Grant will be sent to the DAFPay Network 501(c)(3) nonprofit organization (EIN: 93-1372175). The DAFPay Network will then review and process the grant and send the funds to the intended recipient.
  • direct: Grant will be sent directly to the intended recipient.
addressobjectOptional
userFriendlyIdstringOptionalRead-onlyDeprecated
Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error