Skip to main content
POST
Create stock pledge recommendation

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"

uuid
string<uuid>
required

Unique identifier for the recommendation. Generated on the client side to ensure idempotency.

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

isRebalanceRequested
boolean
default:false

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

Example:

false

Response

Stock pledge recommendation successfully created

id
string
required

The recommendation id

Example:

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