Bulk

Bulk Documentation

Donations [BULK PUT]

Donations [BULK PUT]

Request

Endpoint

PUT /api/v2/account_lists/3f64efc1-87cb-4ac8-af28-990845095139/donations/bulk
Content-Type: application/vnd.api+json

Body

{
  "data": [
    {
      "data": {
        "type": "donations",
        "id": "13a408fb-3aa3-4dde-a1cf-6dbf5f8bdad1",
        "attributes": {
          "amount": "9.99",
          "donation_date": "2021-12-12",
          "appeal_amount": "0.00",
          "motivation": "MyString",
          "payment_method": "MyString",
          "tendered_currency": "ZAR",
          "tendered_amount": "9.99",
          "currency": "ZAR",
          "memo": "MyText",
          "payment_type": "MyString",
          "channel": "MyString",
          "overwrite": true
        },
        "relationships": {
          "appeal": {
            "data": {
              "type": "appeals",
              "id": "533cf8d0-788c-4db5-8726-6725582f2664"
            }
          }
        }
      }
    }
  ]
}

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

[
  {
    "data": {
      "id": "13a408fb-3aa3-4dde-a1cf-6dbf5f8bdad1",
      "type": "donations",
      "attributes": {
        "amount": "9.99",
        "appeal_amount": "0.0",
        "channel": "MyString",
        "converted_amount": 9.99,
        "converted_appeal_amount": 9.99,
        "converted_currency": "USD",
        "created_at": "2022-01-12T17:18:36Z",
        "currency": "ZAR",
        "donation_date": "2021-12-12",
        "legacy_remote_id": null,
        "memo": "MyText",
        "motivation": "MyString",
        "payment_method": "MyString",
        "payment_type": "MyString",
        "remote_id": "20",
        "tendered_amount": "9.99",
        "tendered_currency": "ZAR",
        "updated_at": "2022-01-12T17:18:36Z",
        "updated_in_db_at": "2022-01-12T17:18:36Z"
      },
      "relationships": {
        "appeal": {
          "data": {
            "id": "533cf8d0-788c-4db5-8726-6725582f2664",
            "type": "appeals"
          }
        },
        "contact": {
          "data": null
        },
        "designation_account": {
          "data": {
            "id": "29a59572-d204-4258-9b31-e798f70b3057",
            "type": "designation_accounts"
          }
        },
        "donor_account": {
          "data": {
            "id": "6d5e9eb2-bec8-48fe-8ff5-60bc8f93e0d1",
            "type": "donor_accounts"
          }
        },
        "pledge": {
          "data": {
            "id": "9702a8d1-b8a4-4e20-8bcc-3b05583d5eea",
            "type": "pledges"
          }
        }
      }
    }
  }
]

Fields

data

Type [Donation / error]

Description Array of both Donation objects that have been successfully updated and of errors related to Donation objects that were not updated successfully