Update Grant

PATCH
/v1/grants/:id

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

Path parameters

idstringRequired

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

Request

This endpoint expects an object.
status"Initiated" or "Completed"Optional
Allowed values: InitiatedCompleted

The status of the grant:

  • Initiated: The grant has been initiated and is ready to be processed
  • Completed: The grant has been completed
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 ISO 8601 format.

Response

This endpoint returns an object.
idstring

The unique identifier for the object

workflowSessionIdstring

ID of the Connect Workflow Session associated with this grant

fundIdstring

ID of the donor advised fund

amountdouble

The grant amount expressed in units of whole cents

trackingIdstringOptional

The tracking ID for the grant

externalGrantIdstringOptional

ID of the grant associated with the donor advised fund

createdAtdatetimeOptional

Time when this object was created; expressed in ISO 8601 format

updatedAtdatetimeOptional

Time when this object was last updated; expressed in ISO 8601 format

statusstringOptional

The status of the grant

feeDetailobjectOptional

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

paymentChannel"dafpay_network" or "direct"Optional
Allowed values: dafpay_networkdirect

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) non-profit 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
userFriendlyIdstringOptionalDeprecated

Often referred to as the “Chariot ID”, this is the ID that will be included in the payment from the DAF provider.

Errors

Built with