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

PATCH
/v1/unintegrated_grants/:id
PATCH
/v1/unintegrated_grants/:id
1curl -X PATCH https://api.givechariot.com/v1/unintegrated_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  "createdAt": "2021-08-10T15:00:00Z",
8  "updatedAt": "2021-08-11T15:34:00Z",
9  "status": "Unknown",
10  "metadata": {
11    "key": "value"
12  },
13  "firstName": "Warren",
14  "lastName": "Buffet",
15  "phone": "1237861020",
16  "email": "warrenBuffet@example.com",
17  "address": {
18    "line1": "line1",
19    "line2": "line2",
20    "city": "city",
21    "state": "state",
22    "postalCode": "postalCode"
23  },
24  "note": "Please dedicate in memory of grandma",
25  "paymentChannel": "offline",
26  "userFriendlyId": "1234455"
27}
Update an unintegrated grant object with the given ID. This can be used to update the status or acknowledgement of the unintegrated grant.
Was this page helpful?
Previous

Changelog

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

Path parameters

idstringRequired
The unique id of the unintegrated 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 unintegrated grant
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
statusenum or null
The status of the unintegrated grant. To see a description of each status, see the "Unintegrated Grant Statuses" section of the Chariot documentation.
Allowed values:
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
addressobject or null
notestring or null
An note inputted by the user at submisson
paymentChannel"offline" or nullDefaults to 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.
userFriendlyIdstring or nullDeprecated
Often refered to as the "Chariot ID", this is the ID that will be included in the payment from the DAF provider.

Errors

Update Unintegrated Grant

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

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.

OAuth authentication of the form <token>.

The status of the grant:

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