LogoLogo
Contact usLogin
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Overview
    • Authentication
    • Errors
    • Software Development Kits
    • Webhooks and Events
  • Core Resources
  • Fundraising
Contact usLogin
FundraisingGrants

Update Grant

PATCH
/v1/grants/:id
PATCH
/v1/grants/:id
1curl -X PATCH https://api.givechariot.com/v1/grants/10229488-08d2-4629-b70c-a2f4f4d25344 \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "status": "Initiated"
6}'
Try it
1{
2  "id": "1e60800e-849b-43d1-870e-57afc8d75473",
3  "workflowSessionId": "cfe09e64-6a74-4dab-a565-361185a6f248",
4  "fundId": "daf-id",
5  "amount": 15000,
6  "trackingId": "L9E182VBGP",
7  "externalGrantId": "897823sdjf8sfjs",
8  "createdAt": "2021-08-10T15:00:00Z",
9  "updatedAt": "2021-08-11T15:34:00Z",
10  "status": "Initiated",
11  "feeDetail": {
12    "total": 1500,
13    "contributions": [
14      {
15        "name": "Chariot",
16        "amount": 1500
17      }
18    ]
19  },
20  "metadata": {
21    "key": "value"
22  },
23  "firstName": "Warren",
24  "lastName": "Buffet",
25  "phone": "1237861020",
26  "email": "warrenBuffet@example.com",
27  "note": "Please dedicate in memory of grandma",
28  "statuses": [
29    {
30      "id": "cfe09e64-6a74-4dab-a565-361185a6f248",
31      "createdAt": "2020-01-31T23:00:00Z",
32      "status": "Initiated",
33      "comment": "The grant has been received by the nonprofit"
34    }
35  ],
36  "paymentChannel": "dafpay_network",
37  "address": {
38    "line1": "line1",
39    "line2": "line2",
40    "city": "city",
41    "state": "state",
42    "postalCode": "postalCode"
43  },
44  "userFriendlyId": "chariot-1234455"
45}
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.

Headers

AuthorizationstringRequired
OAuth authentication of the form `<token>`.

Request

This endpoint expects an object.
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

OK
idstringformat: "uuid"
The unique identifier for the object
workflowSessionIdstringformat: "uuid"
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
trackingIdstring or null
The tracking ID for the grant
externalGrantIdstring or null
ID of the grant associated with the donor advised fund
createdAtdatetime or null

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

updatedAtdatetime or null
Time when this object was last updated; expressed in RFC 3339 format
statusstring or null
The status of the grant
feeDetailobject or null
The fee detail of the grant
metadatamap from strings to strings or null
A map of arbitrary string keys and values to store information about the object
firstNamestring or null
The donor's first name
lastNamestring or null
The donor's last name
phonestring or null
The donor's phone number
emailstring or null
The donor's email
notestring or null
An note inputted by the user at submisson
statuseslist of objects or null
The list of grant statuses for this grant
paymentChannelenum or null
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.
Allowed values:
addressobject or null
userFriendlyIdstring or nullDeprecated
Often referred to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

Errors

Was this page helpful?
Previous

List Recurring Grants

Next
Built with
The unique id of the grant. The format should be a v4 UUID according to RFC 4122.
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.
OK

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

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.

The status of the grant:

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

OAuth authentication of the form <token>.