Donor_metrics

>>>

POST /api/v4/donor_metrics
Create Donor Metric

Request body example ↑

{
  "name": "John Alex Dou",
  "email": "jab@email.com",
  "donation_amount": 100,
  "anonymous": true,
  "campaign_id": 363,
  "price_id": "price_1NagczAxd7UNEmWNSnbklxgO",
  "current_url": "https://feature-zb-gp-4193-gipper-fund.d39177vvlcj2i6.amplifyapp.com/Workspace/TEST-CAMPAIGN-04.07/271",
  "sport_ids": [{"id": 1, "amount": 34.50}, {"id": 2, "amount": 34.50}, {"id": 3, "amount": 30.00}]
}

Success response body ↑

{
  "id": 1,
  "name": "John Dou",
  "email": "jd@email.com",
  "donation_amount": 0.0,
  "anonymous": false,
  "campaign_id": 1,
  "campaign_name": "Campaign 1 name",
  "campaign_logo": "https://s3.amazonaws.com/gipper-college-logos-development/study-789631_1280.jpg",
  "workspace_name": "Workspace",
  "status_payment": 0,
  "sports": [
    {
      "id": 1,
      "title": "Sport Football",
      "details": "Lorem ipsum detatils",
      "full_description": "Lorem ipsum full description",
      "cover_image_s3_key": "test.jpg",
      "image_s3_key": "test2.jpg",
      "video_url": "https://youtube.com"
    }...,
  ],
  "stripe_link": "https://checkout.stripe.com/c/pay/cs_test_a1J6G7n4VVHRiWHJtt0JkNpdgVWo9hfUFDTPlgv34FAgDmUNcikpMFwq8P#fidkdWxOYHwnPyd1blpxYHZxWjA0S05rbmZEfWEyUEtAaFJLN1VXaHJVNTxjMUM2Y2dTYW5OazJrc3JvdWljT0AzVXBuSjdQYjRISDBzQ39nU3U1R19RUFxIT390U1NjVDJ2f2FKfE41UTZMNTVrbmJvdUptVicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
}

Params

Param name Description
name
required

name

Validations:

  • Must be a String
email
required

email

Validations:

  • Must be a String
donation_amount
required

amount of payment

Validations:

  • Must be a Float
anonymous
optional

true or false

Validations:

  • Must be one of: true, false, 1, 0.
campaign_id
required

campaign ID

Validations:

  • Must be a Integer
price_id
required

price ID stripe

Validations:

  • Must be a String
current_url
required

current URL

Validations:

  • Must be a String
sport_ids
required

Validations:

  • Must be an Array of nested elements
sport_ids[id]
required

Sport ID

Validations:

  • Must be a String
sport_ids[amount]
optional

Sport donation amout

Validations:

  • Must be a Float
>>>

PUT /api/v4/donor_metrics/:id
Update Donor Metric

Success response body ↑

{
  "id": 1,
  "name": "John Smith",
  "email": "j.smith@email.com",
  "donation_amount": 500.0,
  "anonymous": true,
  "campaign_id": 1,
  "campaign_name": "Campaign 1",
  "campaign_logo": "https://s3.amazonaws.com/gipper-college-logos-development/study-789631_1280.jpg",
  "workspace_name": "Workspace NAME",
  "sports": [
    {
      "id": 1,
      "title": "Sport Football",
      "details": "Lorem ipsum detatils",
      "full_description": "Lorem ipsum full description",
      "cover_image_s3_key": "test.jpg",
      "image_s3_key": "test2.jpg",
      "video_url": "https://youtube.com"
    }...,
  ],
}

Params

Param name Description
url
required

URL from stripe

Validations:

  • Must be a String