Skip to main content
POST
/
v2
/
recommendations
/
pledge-stock
Create a stock pledge recommendation (V2)
curl --request POST \
  --url https://api.endaoment.org/v2/recommendations/pledge-stock \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "updateIdentity": true,
  "shareMyEmail": false,
  "stockPledgeData": {
    "shares": 100,
    "ticker": "AAPL",
    "donorData": {
      "addressLine1": "123 Main St",
      "addressLine2": "Apt 4B",
      "city": "San Francisco",
      "country": "USA",
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumber": "+1 (555) 123-4567",
      "receiptEmail": "john.doe@example.com",
      "state": "CA",
      "zipcode": "94105"
    },
    "brokerData": {
      "brokerContactName": "Jane Smith",
      "brokerEmail": "jane.smith@brokerage.com",
      "brokerName": "Fidelity",
      "brokerPhone": "+1 (555) 987-6543",
      "brokerageAccountNumber": "123456789",
      "customBrokerName": "Local Investment Partners LLC"
    },
    "signature": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "lots": [
      {
        "numberOfShares": 50,
        "purchasePrice": 150.75,
        "purchaseDate": "2023-01-15T00:00:00.000Z",
        "employeeStockPlan": "RSU",
        "lotId": "LOT123"
      }
    ]
  },
  "receivingEntityType": "fund",
  "receivingEntityId": "123e4567-e89b-12d3-a456-426614174000",
  "isRebalanceRequested": false,
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

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"

⌘I