Donor AccountsDonor Accounts

Update Donor Account

Update mutable properties on a Donor Account such as external_id, the nested donor fields, and metadata.

The Donor Account’s status is managed automatically through the Authorization Token verification flow and cannot be changed directly via this endpoint.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The unique id of the Donor Account

Request

The request to update mutable properties on a Donor Account. Note that the Donor Account's status is managed automatically through the Authorization Token verification flow and cannot be changed directly via this endpoint.
donorobjectOptional

Mutable donor identity fields. Only the fields you pass are updated; omitted fields are left unchanged.

external_idstringOptional

The DAF’s internal identifier for this Donor Account. Maximum length: 255 characters.

metadatamap from strings to stringsOptional
A map of arbitrary string keys and values to store information about the object.

Response

OK
idstringRead-only
The unique identifier for this object.
statusenum

The status of a Donor Account.

  • pending: The Donor Account has been created but the DAF has not yet approved or rejected it.
  • approved: The DAF has verified the donor’s identity and Grants from this account can be processed.
  • rejected: The DAF has rejected the Donor Account. Grants from this account will not be processed.
Allowed values:
donorobject
The donor's identity and profile information.
created_atstringRead-onlyformat: "date-time"
Time when this object was created. Expressed in RFC 3339 format.
updated_atstringRead-onlyformat: "date-time"
Time when this object was last updated. Expressed in RFC 3339 format.
external_idstring or null

The DAF’s internal identifier for this Donor Account. Can be set on creation or via Update Donor Account to link the DAFpay Donor Account to the donor’s record in the DAF’s own systems.

approvalobject or nullRead-only

Details about the approval decision. Present when status is approved; otherwise null.

rejectionobject or nullRead-only

Details about the rejection decision. Present when status is rejected; otherwise null.

disabledbooleanRead-onlyDefaults to false

Whether this Donor Account is currently disabled. A disabled Donor Account remains approved but cannot submit new Grant Requests — call Enable Donor Account to re-enable it. Disabling is only available for accounts in approved status.

metadatamap from strings to strings
A map of arbitrary string keys and values to store information about the object.

Errors

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