Skip to main content
POST
Create stock donation pledge

Authorizations

Authorization
string
header
required

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

Body

application/json
stockPledgeData
object
required

Stock pledge details including donor and broker information

receivingEntityType
enum<string>
required

Type of entity receiving the pledge

Available options:
org,
fund,
subproject
Example:

"fund"

receivingEntityId
string<uuid>
required

Unique identifier of the receiving entity

Example:

"123e4567-e89b-12d3-a456-426614174000"

idempotencyKey
string<uuid>
required

Client-generated key to ensure idempotency of the request

Example:

"123e4567-e89b-12d3-a456-426614174000"

updateIdentity
boolean
default:false

Whether to update the user global identity with the provided donor information

Example:

true

shareMyEmail
boolean
default:false

Whether to share donor email with the receiving organization

Example:

false

recommendationId
string<uuid>

Unique identifier of the recommendation that led to this pledge

Example:

"123e4567-e89b-12d3-a456-426614174000"

isRebalanceRequested
boolean
default:false

Whether the fund needs its investments rebalanced after the pledge is fulfilled

Example:

false

donationValueMicroDollars
string

Settled donation value in microdollars. Required at runtime when the resolved partner has reportsSettledOperations: true; ignored otherwise.

Example:

"50000000000"

partnerOperationId
string

Partner-owned reference for this operation. Required at runtime when the resolved partner has reportsSettledOperations: true; ignored otherwise.

Maximum string length: 36
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Stock donation pledge successfully created

id
string<uuid>
required

Unique identifier of the created donation pledge

Example:

"123e4567-e89b-12d3-a456-426614174000"