POST /v1/trees — Plant Trees and Generate a Certificate

Base URL

https://api.bloomy.earth

Endpoint

/v1/trees

Authentication & Headers

Authentication uses HTTP Basic Auth with your Bloomy Earth API credentials. You must use your Bloomy Earth platform username and application password.

You can find and manage these credentials in your Bloomy Earth dashboard, in the Integration API section:
👉 https://www.bloomy.earth/dashboard/#bloomy-integration-api

Headers

Request Body Parameters (JSON)

{
  "trees": 10,
  "projectId": "2056",
  "sendEmail": true,
  "gift": {
    "giftRecipientName": "John Doe",
    "giftRecipientEmail": "john@example.com",
    "giftMessage": "A gift that grows!"
  }
}

JSON Body Parameter Details

Request Behavior

• The organization is determined from the authenticated API user (Basic Auth).
• If projectId is omitted or invalid, Bloomy Earth automatically selects a random reforestation project with a cost of 1 Tree Credit per tree.
• Your Dashboard shows the latest list of projects, their credit cost per tree, and your Tree Credits balance.

Example Requests

Minimal example (auto-selected project & email sent by default)

curl -X POST "https://api.bloomy.earth/v1/trees" \
  -u YOUR_API_USER:YOUR_API_PASSWORD \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "trees": 3
  }'

Standard planting (non-gift, explicit project)

curl -X POST "https://api.bloomy.earth/v1/trees" \
  -u YOUR_API_USER:YOUR_API_PASSWORD \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "trees": 10,
    "projectId": "2056",
    "sendEmail": true
  }'

Gift planting

curl -X POST "https://api.bloomy.earth/v1/trees" \
  -u YOUR_API_USER:YOUR_API_PASSWORD \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "trees": 5,
    "projectId": "2067",
    "gift": {
      "giftRecipientName": "John Doe",
      "giftRecipientEmail": "john@example.com",
      "giftMessage": "A gift that grows!"
    },
    "sendEmail": true
  }'

JSON Response (200)

{
  "success": true,
  "certificateId": "C3295146E582",
  "certificateLink": "https://bloomy.earth/certificate/C3295146E582",
  "treesPlanted": 5,
  "creditsUsed": 5,
  "creditBalance": 14,
  "projectInfo": {
    "name": "Lake Victoria Agroforestry Project in Kenya",
    "country": "Kenya",
    "location": "VQ27+Q7C Kisumu, Kenya",
    "quantity": 5,
    "carbonOffsetKg": 250,
    "reforestedAreaHa": 0.005,
    "creditsPerTree": 1,
    "densityTreesPerHa": 1000
  },
  "isVcsCertified": false,
  "giftSentTo": "john@example.com"
}

(Les valeurs sont données à titre d’exemple.)

Response Fields

Errors

If the request is missing required data, contains invalid parameters, or authentication fails, the API returns a JSON object with an error code and a short message.

Error Format

{
  "error": "unauthorized",
  "message": "Authentication required."
}